Skip to main content
GET
Get a bank deposit intent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

walletId
string
required

Wallet UUID or numeric wallet ID (up to 9 digits).

intentId
string<uuid>
required

Deposit intent UUID.

Response

Deposit intent.

An Open Banking wallet deposit intent.

id
string<uuid>
required

Deposit intent ID.

Example:

"01a13aa3-cc15-709b-a6e0-7cb9cc3a2385"

walletId
string<uuid>
required

Wallet UUID.

Example:

"019ff097-fc59-7310-aa41-3187cbe6c158"

payerId
string<uuid>
required

Payer ID.

Example:

"01a1547d-9495-71ae-b747-dd593df7e32a"

status
enum<string>
required

Deposit intent status.

Available options:
NEW,
PENDING_USER_ACTION,
PENDING_CREDIT,
PAYMENT_RECEIVED,
PAYMENT_COMPLIANCE,
PAYMENT_PROCESS,
PAYMENT_FAILED,
SETTLED,
EXPIRED,
FAILED
amount
number
required

Top-up amount in major currency units, using the currency's decimal precision.

Example:

100.25

intentFee
number
required

Open Banking fee in major currency units, excluding the incoming payment fee.

Example:

0.75

paymentFee
number | null
required

Incoming payment fee in major currency units, excluding the Open Banking fee. Null when no linked credit payment is found.

Example:

0.75

currencyId
string
required

Wallet currency code.

Example:

"GBP"

reference
string
required

Payment reference.

Example:

"G6MGTR6G0R4WW2YP25"

paymentId
string<uuid> | null
required

Linked credit payment UUID; null before a payment is linked.

Example:

"01a1547d-aa2e-709e-878a-e61d83157acc"

expiresAt
integer<int64> | null
required

Expiration Unix timestamp in milliseconds; null when not set.

Example:

1792166400000

createdAt
integer<int64>
required

Creation Unix timestamp in milliseconds.

Example:

1792162800000

updatedAt
integer<int64>
required

Last update Unix timestamp in milliseconds.

Example:

1792162860000