logo

Retrieve financial settings of a gateway account

Retrieves the financial settings of a gateway account with a specified ID.

Important: This operation is experimental and may not be backward compatible.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Responses
200

Financial settings retrieved.

Response Schema: application/json
Array of objects

Risk reserve settings. Use these settings to set up funds reserves before settlement.

Array
filter
required
string [ 1 .. 255 ] characters

Filter that is based on the properties of the transaction and used to determine when to apply the settings.

bips
required
number <integer> (Bips) [ 0 .. 100000 ]

Basis points. Example: 100 bips = 1%, 1 bip = 0.01%.

required
object (RiskReservePeriod)

Instruction for the calculation of reserve release time.

object

Settlement settings. Use these settings to set up settlement accounts.

settlementCurrency
required
string = 3 characters

Default settlement currency for all transactions.

required
object

Default settlement period for all transactions.

method
required
string
Value: "date-interval"
duration
required
integer >= 1

Number of time units.

required
TimeUnit (string) or TimePluralUnit (string)

Unit of time.

object (SettlementPeriodAnchor)
Default: {"method":"immediately"}

Instruction for calculating the settlement period anchor The settlement period anchor is used, in conjunction with the transaction processed time, to calculate the time in which the amount settles.

Array of objects

Advanced settlement settings. Use these settings to override either default settlement currency, period, or both for the transactions matched a filter.

Array
filter
required
string [ 1 .. 255 ] characters

Filter that is based on transaction properties and is used to determine when to apply the settings.

settlementCurrency
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

object (SettlementPeriod)

Instruction for calculating the settlement time. The settlement time is used, in conjunction with the transaction processed time, to calculate the time in which the amount settles.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/gateway-accounts/{id}/financial-settings
Request samples 
Response samples 
application/json
{
  • "riskReserveSettings": [
    ],
  • "settlementSettings": {
    }
}
➔ Next to Set financial settings