Set financial settings
Experimental

Request

Sets financial settings for a gateway account with a specified ID.

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

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

Bodyapplication/json
settlementSettingsobject(SettlementSettings)required

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

riskReserveSettingsArray of objects

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

curl -i -X PUT \
  'https://www.rebilly.com/_mock/catalog/all/gateway-accounts/{id}/financial-settings' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "settlementSettings": {
      "settlementCurrency": "USD",
      "settlementPeriod": {
        "method": "date-interval",
        "duration": 1,
        "unit": "second",
        "anchor": {
          "method": "day-of-month",
          "day": 1,
          "time": "14:15:22Z"
        }
      },
      "advancedSettings": [
        {
          "filter": "currency:EUR,GBP",
          "settlementCurrency": "USD",
          "settlementPeriod": {
            "method": "date-interval",
            "duration": 1,
            "unit": "second",
            "anchor": {
              "method": "day-of-month",
              "day": 1,
              "time": "14:15:22Z"
            }
          }
        }
      ]
    },
    "riskReserveSettings": [
      {
        "filter": "paymentInstrument.method:payment-card",
        "bips": 100,
        "period": {
          "method": "date-interval",
          "duration": 1,
          "unit": "second",
          "anchor": {
            "method": "day-of-month",
            "day": 1,
            "time": "14:15:22Z"
          }
        }
      }
    ]
  }'

Responses

Gateway account financial settings updated.

Headers
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
settlementSettingsobject(SettlementSettings)required

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

riskReserveSettingsArray of objects

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

Response
{ "settlementSettings": { "settlementCurrency": "USD", "settlementPeriod": {}, "advancedSettings": [] }, "riskReserveSettings": [ {} ] }