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.

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.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

consumer_idstringRequiredformat: "uuid"

External ID of the consumer receiving the transfer.

external_payment_card_idstringRequiredformat: "uuid"

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

amountdoubleRequired

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.

descriptionstringOptional

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

Response

OCT created and submitted

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

422

Unprocessable Entity Error

$	curl -X POST /v2/payments/oct/ \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"consumer_id": "7cb94a21-1a3b-4891-9e12-6d1f5a2bc099",
>	"external_payment_card_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
>	"amount": 100,
>	"description": "Payout for January"
>	}'

1	{
2	"id": "a1b2c3d4-0000-4000-8000-000000000002",
3	"consumer_id": "7cb94a21-1a3b-4891-9e12-6d1f5a2bc099",
4	"external_payment_card_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5	"amount": 100,
6	"fee_amount": 2.5,
7	"direction": "Push",
8	"status": "pending",
9	"description": "Payout for January"
10	}