API ReferencePaymentsOCT

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.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequiredformat: "uuid"

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

Response

idstringformat: "uuid"

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

consumer_idstringformat: "uuid"
External ID of the consumer associated with this payment.
external_payment_card_idstringformat: "uuid"
External ID of the payment card that was credited.
amountdouble

Gross transfer amount in USD, inclusive of fee_amount.

fee_amountdouble

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

directionenum

Always Push for OCT transactions.

statusenum

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.

descriptionstringOptional
Description recorded against the transaction.

Errors

404
Not Found Error