v1

latestOpenAPI 3.1.02026-07-247328324.6 KB

Payment

snbx

🧪 Create a deposit

post/simulate/deposit

Headers

IdempotencyKeystring

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 255 characters. See Idempotent Requests.

Example:978771af-77de-4e24-ba39-f602502ceb78

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 255 characters. See Idempotent Requests.

Request body

amountinteger required

Non-negative integer amount in lowest currency denomination. See Money for details.

deposit_account_idstring uuid required

A Universally Unique Identifier (UUID)

payer_banknamestring

Non-empty text string

payer_countrystring

ISO 3166-1 alpha-2 country code

payer_namestring

Non-empty text string

referencestring

Non-empty text string

statement_refstring

Non-empty text string

status'pending' | 'settled' | 'rejected'

Example request

{
  "amount": 10000,
  "deposit_account_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response

Successful operation

amountinteger required

Non-negative integer amount in lowest currency denomination. See Money for details.

deposit_account_idstring uuid required

A Universally Unique Identifier (UUID)

payer_banknamestring

Non-empty text string

payer_countrystring

ISO 3166-1 alpha-2 country code

payer_namestring

Non-empty text string

referencestring

Non-empty text string

statement_refstring

Non-empty text string

status'pending' | 'settled' | 'rejected'

currencystring required

ISO 4217 currency code

created_atstring date-time required

deposit_type'debit' | 'credit' required

fee_amountinteger

Non-negative integer amount in lowest currency denomination. See Money for details.

idstring uuid required

A Universally Unique Identifier (UUID)

Example response

{
  "amount": 10000,
  "deposit_account_id": "550e8400-e29b-41d4-a716-446655440000",
  "currency": "USD",
  "fee_amount": 10000,
  "fee_currency": {
    "currency_code": "USD",
    "precision": 10000
  },
  "id": "550e8400-e29b-41d4-a716-446655440000"
}