Skip to main content
POST
Create same-currency incoming funding transfer

Authorizations

Authorization
string
header
required

Integration-key Basic Auth (clientId:clientSecret) as documented in docs/public/AUTHENTICATION.md.

Headers

Idempotency-Key
string

Optional idempotency key for safely retrying the same transfer-in request.

Body

application/json
customerId
string
required

BLIPS customer UUID that owns the bound external source account for this funding transfer.

platformCustomerId
string
required

Stable platform-side customer reference for the same customer.

source
object
required

Bound external account that funds the same-currency transfer-in.

destination
object
required

Internal account that receives the same-currency deposit.

amount
integer
required

Transfer amount in minor units.

Required range: x >= 1
description
string

Optional deposit description stored with the transfer.

Response

Same-currency incoming funding transfer created.

transactionId
string
required

Canonical public transaction identifier for the created same-currency funding transfer.

type
enum<string>
required

Same-currency incoming transfer type for this endpoint.

Available options:
INCOMING
status
enum<string>
required

Current same-currency funding transfer status.

Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
customerId
string
required

BLIPS customer UUID that owns the transfer.

platformCustomerId
string
required

Platform-side customer reference echoed from the bound customer.

source
object
required

Bound external source account.

destination
object
required

Customer internal destination account.

amount
integer
required

Same-currency transfer amount in minor units.

Required range: x >= 1
currency
string
required

ISO 4217 currency code shared by the source and destination accounts.

description
string | null
required

Optional deposit description echoed from the create request when present.

createdAt
string<date-time>
required

Creation timestamp for the same-currency incoming transfer record.

updatedAt
string<date-time>
required

Last update timestamp for the same-currency incoming transfer record.

settledAt
string<date-time> | null
required

Settlement timestamp when the incoming transfer has completed.