Skip to main content
POST
Simulate a fiat deposit

Authorizations

Authorization
string
header
required

API key as Bearer token

Headers

Reap-Version
enum<string>
required

API version (YYYY-MM-DD)

Available options:
2025-02-14
Example:

"2025-02-14"

Body

Simulate a bank transfer credited to the project's master collateral account

amount
number
required

Amount the sender transferred, credited to the master account

Examples:

100.5

0

1234.99

currency
string
required

Currency the transfer was sent in, as an ISO 4217 alpha code (e.g. HKD). Must be a currency the project accepts top-ups in.

Pattern: ^[A-Z]{3}$
senderName
string

Name of the sender. Randomly generated if omitted.

Required string length: 1 - 255
Example:

"MOON INC LIMITED"

reference
string

Reference the sender attached to the transfer. Absent if omitted.

Required string length: 1 - 255
Example:

"INV-2024-0142"

Response

Response for status 200

id
string<uuid>
required

Unique fiat deposit identifier

accountId
string<uuid>
required

Account credited by the deposit

transactionId
string
required

The bank's unique identifier for the incoming transfer. Use it to reconcile the deposit against a bank statement.

Example:

"20240115HKHHXXXX000123456"

status
enum<string>
required

Current deposit status

Available options:
SETTLED
Example:

"SETTLED"

amount
number
required

Amount credited to the account balance

Required range: x >= 0
Examples:

100.5

0

1234.99

currency
string
required

Currency the credit was applied in

Examples:

"USD"

"HKD"

"EUR"

originalAmount
number
required

Amount of the incoming transfer, as received by the bank

Required range: x >= 0
Examples:

100.5

0

1234.99

originalCurrency
string
required

Currency the transfer was sent in, as the bank reported it. A transfer must be sent in the billing currency of your card program.

Examples:

"USD"

"HKD"

"EUR"

senderName
string | null
required

Name of the sender, when the bank reported one

Example:

"MOON INC LIMITED"

reference
string | null
required

Reference the sender attached to the transfer, when present

Example:

"INV-2024-0142"

occurredAt
string
required

ISO 8601 timestamp of when the bank received the transfer

Example:

"2024-01-15T10:30:00Z"

createdAt
string
required

ISO 8601 timestamp of creation

Example:

"2024-01-15T10:30:00Z"

updatedAt
string
required

ISO 8601 timestamp of last update

Example:

"2024-01-15T10:35:00Z"