Create AFT Payment Request

Create an AFT (Account Funding Transaction) to pull funds from a consumer's registered external debit card into their Upward DDA. The card must already be registered through the card-registration component and have `pullEnabled: true`. `amount` is the gross amount debited from the card; the fee is deducted from it, so the consumer's DDA receives `amount - fee_amount`. Returns `200` with a payment in `pending`; settlement is reported asynchronously through the `Payment.Aft.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 initiating the transfer.
external_payment_card_idstringRequiredformat: "uuid"

external_id of the registered external payment card to pull funds from. The card must belong to consumer_id and have pullEnabled: true.

amountdoubleRequired

Gross amount to pull in USD. Minimum 1.00; the maximum is the partner’s configured AFT limit. The fee is deducted from this amount, so the DDA is credited amount - fee_amount.

descriptionstringOptional

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

Response

AFT created and submitted
idstringformat: "uuid"

Unique identifier for this payment. Use it with GET /v2/payments/aft/{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 debited.
amountdouble

Gross transfer amount in USD, inclusive of fee_amount.

fee_amountdouble

Fee deducted from amount. The DDA is credited amount - fee_amount.

directionenum

Always Pull for AFT 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