Create Disbursement Transfer

post

https://example.com/programs/{programCode}/accounts/{accountIdentifier}/disbursements/transfer/{transferIdentifier}

Performs a generic disbursement transfer for the specified account and program. Use for sending funds to a destination.

Path Params

programCode

string

required

The program code associated with the request.

accountIdentifier

string

required

The unique identifier of the account.

transferIdentifier

string

required

The unique identifier of the transfer.

Body Params

The request payload containing transfer details.

Create Transfer Request – Represents the data required to initiate a generic transfer.
Used to request a transfer between source and destination URIs for a given account and transfer identifier.

sourceUri

string | null

The URI of the source for the transfer.

destinationUri

string | null

The URI of the destination for the transfer.

currency

string | null

The currency code for the transfer (e.g., "USD").

amount

string | null

The amount to transfer.

description

string | null

The description of the transfer.

transactionDate

string | null

The date of the transaction (format: yyyy-MM-dd).

Headers

X-GD-RequestId

string

required

The unique request identifier for tracking.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

401

Unauthorized

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

text/json

201Created

403Forbidden

500Internal Server Error

503Service Unavailable