API Reference

Assess ACH Transfer Prerequisites

post
https://example.com/programs//transfers/assessment/ach

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

Path Params
string
required

The program code for the partner implementation.

Body Params

The Gd.Bos.DataTransfer.Request.AssessACHRequest containing ACH transfer details.

string | null

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

string | null

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).

string | null

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

string
enum

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

Allowed:
string | null

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

string | null

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

transferRoute
object

Represents the routing details and required data for initiating a transfer operation. Contains transaction amount, delivery type, source and target endpoints, recurring and verification details, and ACH-specific flags. Used to define and process the flow of funds between accounts or external endpoints, supporting ACH, purse-to-purse, and partner-to-account transfers.

string | null

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

Headers
string
required

A unique identifier (GUID) for tracking the request.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago