Create Account Funding Transaction

post

https://sandbox-api.readyremit.com/v1/account-funding-transactions

The POST /account-funding-transactions endpoint executes a request to fund an account. The account to which funds are added to is defined with the sourceAccountId in the request.

Implementation Guide:

Prerequisite: Before submitting an account funding transaction, a sourceAccountId should be obtained by first getting an onboarding session POST /card-onboarding-sessions, then creating a card POST /cards, and finally creating a sender account POST /accounts. The accountId returned by POST /accounts is the sourceAccountId.
Quote Required: Obtain a real-time quote using GET /quote with transferMethod: ACCOUNT_FUNDING before submitting. Include the returned quoteId in the request.
Optional Fields: The fields array is optional. When provided for account funding, include CARD_PROXY_NUMBER, whose value is the proxy (pseudo account) number that identifies the sender's funding account created during onboarding.
Transfer Method: This endpoint is exclusively for the ACCOUNT_FUNDING transfer method. For other transfer methods, use the POST /transfers endpoint.
Examples: See the example request and response payloads below.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

quoteBy

string

enum

required

Defaults to SEND_AMOUNT

This parameter determines how the quote is calculated, based on either the sender amount or the recipient amount. It helps in providing an accurate estimate for the transfer. See quoteBy. Example: "SEND_AMOUNT"

Allowed:

amount

integer

required

≥ 0

Numeric Value. The amount an account holder wishes to fund. Example: If you want to fund $30.00 USD, this would be 3000. See how to format an amount based on the currency. Example: 3000

quoteId

string

required

The quote ID obtained from the GET /quote response using transferMethod: ACCOUNT_FUNDING. This links the transaction to the pre-calculated rate and fee. Example: "a3f92c1d-8b74-4e2a-9d35-7c81f0e4b256"

sourceAccountId

string

required

The unique identifier of the source account from which funds will be loaded. This must correspond to a valid account associated with the sender. Example: "04eda1ab-664b-4983-a3a1-9c2ab9181895"

nonce

uuid | null

Optional unique identifier obtained from the GET /nonce endpoint. Use this to prevent duplicate transaction submissions. Each nonce can only be used once per customer. Example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

fields

array of objects

A list of dynamic fields associated with the account funding transaction. When provided, include the CARD_PROXY_NUMBER field, whose value is the proxy (pseudo account) number that identifies the sender's funding account created during onboarding.

fields

Responses

200The account funding transaction was successfully executed.

400The request was invalid. This response typically occurs if required parameters are missing or invalid.

401The request requires user authentication. This response occurs if the authentication token is missing or invalid.

403The request was valid, but the server is refusing action. This response occurs if the user does not have permission to execute the account funding transaction.

404The account funding transaction could not be executed. This response occurs if the parameters provided do not match any available options.