API Reference
Start typing to search…

Create Transfer (B2C, A2A, or P2P)

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

Transfers funds from a program funding source to a consumer account. The transferType differentiates B2C, A2A, or P2P transactions. Returns details of the created transfer.

Path Params
string
required

The program code for the partner implementation.

Body Params

The Gd.Bos.DataTransfer.Request.TransferRequest containing transfer details, including source, target, and transfer type.

string | null

Required. A unique identifier for the transfer, generated by the client for idempotency and tracking.

string | null

Required. The type of transfer to perform. Use A2AOut for Debit Card transfers.Use DisbursementExternal for B2C Disbursements.Use PartnerA2A for partner account-to-account transfers.Use A2A for account-to-account transfers.

string | null

Required. The authorization type for the transfer. This must be set to execute.

string | null

Required. The identifier of the funding source account (initiator) for the transfer.

string | null

Optional. The identifier for the bank account verification process. Used only for ACH Pull transfers.

string | null

Optional. The unique identifier of the user initiating the transfer. Used only for ACH Out transfers.

string | null

Optional. A memo or note to associate with the transfer.

string | null

Optional. A description for the transfer, such as the purpose or reference for the transaction.

string | null

Optional. Partner-provided reference data for cross-referencing the transfer in settlement reports. Including this field enables the partner to match the report information with internal records.

transferRoute
object

Represents the routing and endpoint details for a funds transfer operation. Contains information about the transaction amount, description, fee handling, and the source and target endpoints. Used for transfers between accounts, cards, or external endpoints, supporting a variety of transfer types such as A2A, B2C, and partner-initiated transfers.

fraudData
object | null

Optional. A dictionary of key/value pairs containing additional fraud detection data for the transfer. Expected keys for transfer types IFTSend and ECashSend include deviceId and customerIP.

deviceDetails
object

Represents device-specific information used when initiating a funds transfer or other sensitive operation. This data is used for device identification, risk assessment, and fraud prevention.

Headers
string
required

A unique identifier (GUID) for tracking the request.

string

The call mode for AB testing or routing (optional).

string

The maximum retry duration for the transfer (optional).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
Response 
 Choose an example:
application/json
text/json
Updated 2 months ago