Syncing Payment Options¶

Overview¶

Use the SyncPaymentOptions endpoint to inform BRIJ about your service capabilities. This endpoint operates in full replacement mode - each sync completely replaces your previous configuration.

Endpoint¶

POST https://api.brij.fi/brij.core.v1.partner.Service/SyncPaymentOptions

Request Body¶

{
  "countryAvailabilities": [
    {
      "countryCode": "USA",
      "paymentMethod": "USA_ACH",
      "onrampEnabled": true,
      "offrampEnabled": true
    },
    {
      "countryCode": "BRA",
      "paymentMethod": "BRA_PIX",
      "onrampEnabled": true,
      "offrampEnabled": false
    }
  ],
  "limits": [
    {
      "currency": "USD",
      "onrampLimitMin": "10.00",
      "onrampLimitMax": "10000.00",
      "offrampLimitMin": "50.00",
      "offrampLimitMax": "5000.00"
    }
  ],
  "cryptoAvailabilities": [
    {
      "currency": "SOLANA_SOL",
      "onrampEnabled": true,
      "offrampEnabled": true
    },
    {
      "currency": "ETHEREUM_ETH",
      "onrampEnabled": true,
      "offrampEnabled": false
    }
  ],
  "fiatPaymentAvailabilities": [
    {
      "currency": "USD",
      "paymentMethod": "USA_ACH",
      "onrampEnabled": true,
      "offrampEnabled": true
    },
    {
      "currency": "BRL",
      "paymentMethod": "BRA_PIX",
      "onrampEnabled": true,
      "offrampEnabled": false
    }
  ]
}

Request Parameters¶

`countryAvailabilities` (array)¶

Defines which countries and payment methods you support.

Field	Type	Description
`countryCode`	string	ISO 3166-1 alpha-3 country code (e.g., "USA", "GBR", "BRA")
`paymentMethod`	string	Payment method code (see Payment Methods)
`onrampEnabled`	boolean	Whether you support buying crypto (fiat → crypto)
`offrampEnabled`	boolean	Whether you support selling crypto (crypto → fiat)

`limits` (array)¶

Defines transaction limits per currency.

Field	Type	Description
`currency`	string	Currency code (see Currency Codes)
`onrampLimitMin`	string	Minimum amount for buying crypto (decimal as string)
`onrampLimitMax`	string	Maximum amount for buying crypto (decimal as string)
`offrampLimitMin`	string	Minimum amount for selling crypto (decimal as string)
`offrampLimitMax`	string	Maximum amount for selling crypto (decimal as string)

Note

Limits should be specified in the currency's natural units (e.g., "10.50" for USD)
Limits should only be set for fiat currencies (e.g., USD, EUR, BRL), not crypto currencies

`cryptoAvailabilities` (array)¶

Defines which cryptocurrencies you support.

Field	Type	Description
`currency`	string	Crypto currency code (see Currency Codes)
`onrampEnabled`	boolean	Whether you support buying this cryptocurrency
`offrampEnabled`	boolean	Whether you support selling this cryptocurrency

`fiatPaymentAvailabilities` (array)¶

Defines which fiat currencies and payment method combinations you support.

Field	Type	Description
`currency`	string	Fiat currency code (see Currency Codes)
`paymentMethod`	string	Payment method code (see Payment Methods)
`onrampEnabled`	boolean	Whether you support buying crypto with this fiat/payment method
`offrampEnabled`	boolean	Whether you support selling crypto to this fiat/payment method

Response¶

{
  "countryAvailabilitiesSynced": 2,
  "limitsSynced": 1,
  "cryptoAvailabilitiesSynced": 2,
  "fiatPaymentAvailabilitiesSynced": 2
}

Field	Type	Description
`countryAvailabilitiesSynced`	integer	Number of country availability records synced
`limitsSynced`	integer	Number of limit records synced
`cryptoAvailabilitiesSynced`	integer	Number of crypto availability records synced
`fiatPaymentAvailabilitiesSynced`	integer	Number of fiat payment availability records synced

Error Responses¶

Status Code	Description
`401`	Invalid or missing API key
`404`	Partner not found
`500`	Internal server error