Skip to main content
POST
Confirm a bank transfer

Authorizations

x-api-key
string
header
required

Enter your API key

Headers

Idempotency-Key
string

Choose one key per transfer. Retrying the same body and key replays a successfully stored response for 24 hours; a different body returns IDEMPOTENCY_KEY_REUSED.

Body

application/json
product
string
required

Bank transfer confirmations are available for CARD only.

Allowed value: "CARD"
network
enum<string>
required

The bank rail from your funding instructions: FPS (HKD) or CHATS (USD).

Available options:
FPS,
CHATS
amount
object
required
referenceId
string
required

The IBM-XXXXXX Reference ID from your bank instructions.

Pattern: ^IBM-[A-F0-9]{6}$

Response

id
string
required

The confirmation's ID.

product
string
required
Allowed value: "CARD"
status
string
required

The confirmation status, for example PENDING.

amount
object
required

The confirmed transfer amount.

referenceId
string
required

The Reference ID this confirmation applies to.

createdAt
string<date-time>
required

When the confirmation was recorded, in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$