PUT /gateway-accounts/{id}/financial-settings
Sets financial settings for a gateway account with a specified ID.
Important: This operation is experimental and may not be backward compatible.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
riskReserveSettings[] |
Array | No |
Risk reserve settings. Use these settings to set up funds reserves before settlement. |
riskReserveSettings[].bips |
Number | Yes |
Basis points. Example: 100 bips = 1%, 1 bip = 0.01%. |
riskReserveSettings[].filter |
String | Yes |
Filter that is based on the properties of the transaction and used to determine when to apply the settings. |
riskReserveSettings[].period |
Object | Yes |
Instruction for calculating the reserve release time. |
riskReserveSettings[].period.method |
String | Yes |
Valid values:
|
riskReserveSettings[].period.anchor |
Object | No |
Instruction for calculating the period anchor. |
riskReserveSettings[].period.duration |
Integer | Yes |
Number of time units. |
riskReserveSettings[].period.unit |
Yes |
Unit of time. |
|
settlementSettings |
Object | Yes |
Settlement settings. Use these settings to set up settlement accounts. |
settlementSettings.settlementCurrency |
String | Yes |
Default settlement currency for all transactions. |
settlementSettings.advancedSettings[] |
Array | No |
Advanced settlement settings. Use these settings to override either default settlement currency, period, or both for the transactions matched a filter. |
settlementSettings.advancedSettings[].filter |
String | Yes |
Filter that is based on transaction properties and is used to determine when to apply the settings. |
settlementSettings.advancedSettings[].settlementCurrency |
String | No |
Currency code in ISO 4217 format. |
settlementSettings.advancedSettings[].settlementPeriod |
Object | No |
Instruction for calculating the settlement time. The settlement time and settlement period anchor are used in conjunction with the transaction processed time, to calculate the time in which the amount settles. |
settlementSettings.settlementPeriod |
Object | Yes |
Default settlement period for all transactions. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.