Sign in
latestOpenAPI 3.1.02026-08-22124199170.4 KB

8a237f1f704f

payments

Retrieve OCT Payment Request

Retrieve a single OCT payment by the id returned at creation time. Returns 404 for payments belonging to another partner's consumers.

get/v2/payments/oct/{id}/

Path parameters

idstring uuid required

The unique ID of the OCT payment (returned at creation time).

Headers

Authorizationstring required

Bearer authentication

Response

idstring uuid required

Unique identifier for this payment. Use it with GET /v2/payments/oct/{id}/.

consumer_idstring uuid required

External ID of the consumer associated with this payment.

external_payment_card_idstring uuid required

External ID of the payment card that was credited.

amountnumber double required

Gross transfer amount in USD, inclusive of fee_amount.

fee_amountnumber double required

Fee deducted from amount. The card receives amount - fee_amount.

descriptionstring

Description recorded against the transaction.

direction'Push' required

Always Push for OCT transactions.

status'queued' | 'pending' | 'pending_review' | 'posted' | 'canceled' | 'error' | 'rejected' | 'returned' required

Lifecycle status of a card payment. pending is returned at creation; posted means funds have settled. pending_review indicates the payment is held for compliance review.