Skip to main content
GET
Get a payment

Authorizations

Authorization
string
header
required

Stablepay API key. Include as Authorization: Bearer <key>.

Path Parameters

paymentId
string
required

The pay_-prefixed payment ID.

Response

Payment found.

id
string
required

Prefixed ULID for this payment.

Example:

"pay_01HV8KZMRJPQR9S7T3XABCDEF"

status
string
required

Current state of the payment in the state machine. initiatedprovider_acceptedsucceeded | failed | refunded

direction
enum<string>
required

payout: issuer sends stablecoin → recipient receives fiat. payin: customer pays fiat → issuer receives stablecoin.

Available options:
payin,
payout
paymentMethod
enum<string>
required

The supported payment method used to deliver funds to the recipient.

Available options:
BANK,
MOMO,
PAYBILL,
TILL
sourceCurrency
enum<string>
required

Stablecoin sent onchain for payment settlement.

Available options:
USDC,
USDT
amountStablecoin
string
required

Total stablecoin amount charged.

Example:

"10.500"

fiatAmount
string
required

Fiat amount the recipient receives.

Example:

"1350"

destinationCurrency
enum<string>
required

Fiat currency received by the recipient.

Available options:
CDF,
GHS,
KES,
NGN,
TZS,
UGX,
XAF,
XOF,
ZAR,
ZMW
providerRef
string | null
required

Provider's transaction ID. Null until the provider accepts.

Example:

"CC4SOjQu8UUarKaOGZy9"

reference
string | null
required

Caller's own reference code (e.g. "csh-txn-20260506-001"). Stored as supplied in the payment request.

Example:

"csh-txn-20260506-001"

errorCode
string | null
required

Machine-readable failure code (e.g. insufficient_funds or invalid_account). Null unless status is failed.

Example:

null

failureReason
string | null
required

Human-readable description of why the payment failed. Null unless status is failed.

Example:

null

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
depositInstruction
object | null

Money-in only. Bank account the customer must transfer fiat into to complete a bank payin.