Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Transfers

Assess ACH Transfer Prerequisites

Verifies ACH Pull limits, frequency, delivery type, and bank account verification method for ACH authorization. Returns assessment results and any unmet requirements.

post/programs/{programCode}/transfers/assessment/ach

Path parameters

programCodestring required

The program code for the partner implementation.

Headers

X-GD-RequestIdstring required

A unique identifier (GUID) for tracking the request.

Request body

transferIdentifierstring nullable

Required: A unique identifier for the transfer. This value is generated by the client and used for idempotency and tracking.

transferTypestring nullable

Required: The type of ACH transfer to perform. Valid values: "achOut" (move funds to an external bank account), "achPull" (pull funds from an external bank account).

currencystring nullable

Required: The ISO 4217 currency code for the transfer (e.g., "USD") in string.

deviceType'Unknown' | 'Web' | 'IOS' | 'Android'

Required: The device type from which the transfer is initiated. Valid values: Unknown, Web, IOS, Android.

verificationIdentifierstring nullable

Optional: The identifier for the bank account verification process. Required for ACH Pull transfers when bank account verification is needed.

userIdentifierstring nullable

Optional: The unique identifier of the user initiating the transfer. Required for both ACH Out and ACH Pull transfers.

transferDescriptionstring nullable

An optional description for the transfer, such as the purpose or reference for the transaction.

Response

OK

availableBalancenumber double nullable

The available balance in the source account at the time of assessment. Used to determine if sufficient funds are present to complete the transfer.

prerequisitesstring[] nullable

A list of prerequisite conditions that must be met before the transfer can proceed. If any prerequisites are returned, the customer must fulfill them to be eligible for the transfer.

netAmountnumber double

The net amount that will be transferred after deducting all applicable fees.