Transfers

Create Transfer (B2C, A2A, or P2P)

Changed on Nov 3, 2026

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.

post/programs/{programCode}/transfers

Request

The document declares no server URL.
Auth
API key in header Authorization

Path parameters

programCodestring required

The program code for the partner implementation.

Headers

X-GD-RequestIdstring required

A unique identifier (GUID) for tracking the request.

X-GD-CallModestring

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

X-GD-MaxRetryDurationstring

The maximum retry duration for the transfer (optional).

Request body

transferIdentifierstring nullable

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

transferTypestring nullable

Required. The type of transfer to perform. <list type="bullet"><item><description>Use A2AOut for Debit Card transfers.</description></item><item><description>Use DisbursementExternal for B2C Disbursements.</description></item><item><description>Use PartnerA2A for partner account-to-account transfers.</description></item><item><description>Use A2A for account-to-account transfers.</description></item></list>

transferAuthorizationTypestring nullable

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

initiatorstring nullable

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

verificationIdentifierstring nullable

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

userIdentifierstring nullable

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

memostring nullable

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

transferDescriptionstring nullable

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

partnerReferenceDatastring nullable

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.

fraudDataobject nullable

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.

Example request

{
  "transferIdentifier": "00000000-0000-0000-0000-000000000000",
  "transferType": "A2AOut",
  "transferAuthorizationType": "execute",
  "initiator": "{accountIdentifierSource}",
  "transferDescription": "peerPayment",
  "transferRoute": {
    "transactionDescription": "peerPayment",
    "transactionAmount": 1,
    "sourceTransferEndpoint": {
      "transferEndPointType": "account",
      "identifier": "{{accountIdentifierSource}}",
      "currency": "USD"
    },
    "targetTransferEndpoint": {
      "transferEndPointType": "account",
      "identifier": "{{accountIdentifierSource}}",
      "currency": "USD"
    }
  }
}

Response

Created

fraudDataobject nullable

Optional. A dictionary of key/value pairs containing fraud detection data associated with the transfer. This data may be returned if fraud checks were performed during the transfer process.

Changes

Nov 3, 202628aa54bed51e Revision changes
- warning
  removed the request property (media type: application/json-patch+json)
- warning
  removed the request property (media type: application/json)
- warning
  removed the request property (media type: text/json)
- warning
  removed the request property (media type: application/*+json)
- warning
  removed the request property (media type: application/json-patch+json)
- warning
  removed the request property (media type: application/json)
- warning
  removed the request property (media type: text/json)
- warning
  removed the request property (media type: application/*+json)
- warning
  removed the request property (media type: application/json-patch+json)
- warning
  removed the request property (media type: application/json)
- warning
  removed the request property (media type: text/json)
- warning
  removed the request property (media type: application/*+json)
- warning
  removed the request property (media type: application/json-patch+json)
- warning
  removed the request property (media type: application/json)
- warning
  removed the request property (media type: text/json)
- warning
  removed the request property (media type: application/*+json)
- info
  added the new optional request property (media type: application/json-patch+json)
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: text/json)
- info
  added the new optional request property (media type: application/*+json)
- info
  added the new optional request property (media type: application/json-patch+json)
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: text/json)
- info
  added the new optional request property (media type: application/*+json)
- info
  added the new optional request property (media type: application/json-patch+json)
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: text/json)
- info
  added the new optional request property (media type: application/*+json)
- info
  added the new optional request property (media type: application/json-patch+json)
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: text/json)
- info
  added the new optional request property (media type: application/*+json)
- info
  added the new optional request property (media type: application/json-patch+json)
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: text/json)
- info
  added the new optional request property (media type: application/*+json)
- info
  added the new optional request property (media type: application/json-patch+json)
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: text/json)
- info
  added the new optional request property (media type: application/*+json)
- info
  added the new optional request property (media type: application/json-patch+json)
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: text/json)
- info
  added the new optional request property (media type: application/*+json)
- info
  added the new optional request property (media type: application/json-patch+json)
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: text/json)
- info
  added the new optional request property (media type: application/*+json)
- info
  added the new optional request property (media type: application/json-patch+json)
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: text/json)
- info
  added the new optional request property (media type: application/*+json)
- info
  added the new optional request property (media type: application/json-patch+json)
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: text/json)
- info
  added the new optional request property (media type: application/*+json)
- info
  added the new optional request property (media type: application/json-patch+json)
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: text/json)
- info
  added the new optional request property (media type: application/*+json)
- info
  added the new optional request property (media type: application/json-patch+json)
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: text/json)
- info
  added the new optional request property (media type: application/*+json)

Operation history