latestOpenAPI 3.1.02026-08-22124199170.4 KB

8a237f1f704f

payments

Create OCT Payment Request

Create an OCT (Original Credit Transaction) to push funds from the consumer's Upward DDA to their registered external debit card. The card must already be registered through the card-registration component and have pushEnabled: true. amount is the gross amount debited from the DDA; the fee is deducted from it, so the card receives amount - fee_amount. Returns 200 with a payment in pending; settlement is reported asynchronously through the Payment.Oct.Completed webhook.

post/v2/payments/oct/

Headers

Authorizationstring required

Bearer authentication

Request body

consumer_idstring uuid required

External ID of the consumer receiving the transfer.

external_payment_card_idstring uuid required

external_id of the registered external payment card to credit. The card must belong to consumer_id and have pushEnabled: true.

amountnumber double required

Gross amount to push in USD. Minimum 1.00; the maximum is the partner's configured OCT limit. The fee is deducted from this amount, so the card receives amount - fee_amount.

descriptionstring

Optional description for the transaction. Defaults to Instant Funds Transfer Out.

Response

OCT created and submitted

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.

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.