Program Transfers
A program transfer moves funds from an account holder’s GPA to a program funding source. As opposed to a fee transfer, the transfer amount is specified by the transfer itself and is therefore a dynamically settable value. An auto reload is triggered if the GPA has insufficient funds to cover the transfer amount and auto reload is enabled.
Create program transfer
Copy section link
Action: POST
Endpoint: /programtransfers
Use this endpoint to create a program transfer. Add the program transfer details to the body of the request in JSON format.
Include either user_token or business_token in the message body to specify the account holder whose GPA will be debited by the program transfer.
The user or business must already exist.
A program transfer is an all-or-nothing operation. If the GPA has insufficient funds to cover both the amount of the program transfer and all attached fees, then no funds are transferred.
Request body
Copy section link
| Fields | Description |
|---|---|
amount
decimal
|
Amount of program transfer. Allowable Values: Format: 0.00 |
business_token
string
|
The unique identifier of the business.
Pass either a Send a Allowable Values: 1–36 chars |
currency_code
string
|
The three-digit ISO 4217 currency code. Allowable Values: A valid three-digit ISO 4217 currency code |
fees
array of objects
|
Contains attributes that define characteristics of one or more fees. Allowable Values: A valid |
fees[].memo
string
|
Memo or note describing the fee. Allowable Values: 1–99 chars |
fees[].tags
string
|
Comma-delimited list of tags describing the fee. Allowable Values: 255 char max |
fees[].token
string
|
Specifies the fee to add. Allowable Values: 1–36 chars |
memo
string
|
Memo or note describing the program transfer. Allowable Values: 1–99 chars |
tags
string
|
Comma-delimited list of tags describing the program transfer. Allowable Values: 1–255 chars |
token
string
|
If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 1–36 chars |
type_token
string
|
The unique identifier of the program transfer type. Send a Allowable Values: 1–36 chars |
user_token
string
|
The unique identifier of the user.
Pass either a Send a Allowable Values: 1–36 chars |
Response body
Copy section link
| Fields | Description |
|---|---|
amount
decimal
|
Amount of program transfer. Allowable Values: Format: 0.00 |
business_token
string
|
The unique identifier of the business. This field is returned if it exists in the resource. Allowable Values: 1–36 chars |
created_time
datetime
|
The date and time when the program transfer object was created, in UTC.
Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
currency_code
string
|
The three-digit ISO 4217 currency code. This field is returned if it exists in the resource. Allowable Values: A valid three-digit ISO 4217 currency code |
fees
array of objects
|
Contains attributes that define characteristics of one or more fees. This array is returned if it exists in the resource. Allowable Values: A valid |
fees[].fee
object
|
Contains details about the fee. Allowable Values: A valid |
fees[].fee.active
boolean
|
Indicates whether the fee is active. Allowable Values:
|
fees[].fee.amount
decimal
|
The amount of the fee. Allowable Values: Format: 0.00 |
fees[].fee.created_time
datetime
|
The date and time when the Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
fees[].fee.currency_code
string
|
The three-digit ISO 4217 currency code. Allowable Values: A valid three-digit ISO 4217 currency code |
fees[].fee.last_modified_time
datetime
|
The date and time when the Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
fees[].fee.name
string
|
The name of the Allowable Values: 50 char max |
fees[].fee.real_time_assessment
object
|
Controls the assessment of real-time fees. This object is returned if it exists in the resource. Allowable Values: A valid |
fees[].fee.real_time_assessment.domestic_enabled
boolean
|
Enables fee assessments where the origin of the transaction acquirer is inside the US. This field is returned if it exists in the resource. Allowable Values:
|
fees[].fee.real_time_assessment.international_enabled
boolean
|
Enables fee assessments where the origin of the transaction acquirer is outside the US. This field is returned if it exists in the resource. Allowable Values:
|
fees[].fee.real_time_assessment.transaction_type
string
|
Indicates the type of transactions on which the fee is assessed. This field is returned if it exists in the resource. Allowable Values:
|
fees[].fee.tags
string
|
Descriptive metadata about the fee. This field is returned if it exists in the resource. Allowable Values: 255 char max |
fees[].fee.token
string
|
The unique identifier of the fee. This field is returned if it exists in the resource. Allowable Values: 36 char max |
fees[].memo
string
|
Additional text that describes the fee. This field is returned if it exists in the resource. Allowable Values: 1–99 chars |
fees[].tags
string
|
Comma-delimited list of tags describing the fee. This field is returned if it exists in the resource. Allowable Values: 255 char max |
fees[].token
string
|
The unique identifier of the fee. Send a Allowable Values: 1–36 chars |
fees[].transaction_token
string
|
Unique identifier of the transaction. Allowable Values: Format: UUID |
List program transfers
Copy section link
Action: GET
Endpoint: /programtransfers
Use this endpoint to list all program transfers.
To narrow your result set to program transfers of a particular type or that are associated with a particular account holder, include the appropriate parameters from the following Query Parameters table. This endpoint also supports field filtering, pagination, and sorting.
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of program transfers to retrieve. Allowable Values: Any integer |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: A comma-delimited list of fields, or blank |
sort_by
string
|
Field on which to sort.
Use any field in the resource model, or one of the system fields Allowable Values:
|
user_token
string
|
Identifies the Send a Allowable Values: Existing user token |
business_token
string
|
Identifies the Send a Allowable Values: Existing buiness token |
type_token
string
|
Identifies the type of program transfers to retrieve. Allowable Values: Existing program transfer type token |
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of program transfer resources to retrieve. Allowable Values: 1-10 |
data
array of objects
|
An array of program transfer objects. This array is returned if it exists in the resource. Allowable Values: A valid |
data[].amount
decimal
|
Amount of program transfer. This field is returned if it exists in the resource. Allowable Values: Format: 0.00 |
data[].business_token
string
|
The unique identifier of the business. This field is returned if it exists in the resource. Allowable Values: 1–36 chars |
data[].created_time
datetime
|
The date and time when the program transfer object was created, in UTC.
Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
data[].currency_code
string
|
The three-digit ISO 4217 currency code. This field is returned if it exists in the resource. Allowable Values: A valid three-digit ISO 4217 currency code |
data[].fees
array of objects
|
Contains attributes that define characteristics of one or more fees. This array is returned if it exists in the resource. Allowable Values: A valid |
data[].fees[].fee
object
|
Contains details about the fee. This object is returned if it exists in the resource. Allowable Values: A valid |
data[].fees[].fee.active
boolean
|
Indicates whether the fee is active. This field is returned if it exists in the resource. Allowable Values:
|
data[].fees[].fee.amount
decimal
|
The amount of the fee. Allowable Values: Format: 0.00 |
data[].fees[].fee.created_time
datetime
|
The date and time when the Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
data[].fees[].fee.currency_code
string
|
The three-digit ISO 4217 currency code. Allowable Values: A valid three-digit ISO 4217 currency code |
data[].fees[].fee.last_modified_time
datetime
|
The date and time when the Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
data[].fees[].fee.name
string
|
The name of the Allowable Values: 50 char max |
data[].fees[].fee.real_time_assessment
object
|
Controls the assessment of real-time fees. This field is returned if it exists in the resource. Allowable Values: A valid |
data[].fees[].fee.real_time_assessment.domestic_enabled
boolean
|
Enables fee assessments where the origin of the transaction acquirer is inside the US. This field is returned if it exists in the resource. Allowable Values:
|
data[].fees[].fee.real_time_assessment.international_enabled
boolean
|
Enables fee assessments where the origin of the transaction acquirer is outside the US. This field is returned if it exists in the resource. Allowable Values:
|
data[].fees[].fee.real_time_assessment.transaction_type
string
|
Indicates the type of transactions on which the fee is assessed. This field is returned if it exists in the resource. Allowable Values:
|
data[].fees[].fee.tags
string
|
Descriptive metadata about the fee. This field is returned if it exists in the resource. Allowable Values: 255 char max |
data[].fees[].fee.token
string
|
The unique identifier of the fee. This field is returned if it exists in the resource. Allowable Values: 36 char max |
data[].fees[].memo
string
|
Additional text that describes the fee. This field is returned if it exists in the resource. Allowable Values: 1–99 chars |
data[].fees[].tags
string
|
Comma-delimited list of tags describing the fee. This field is returned if it exists in the resource. Allowable Values: 255 char max |
data[].fees[].token
string
|
The unique identifier of the fee. Send a Allowable Values: 1–36 chars |
data[].fees[].transaction_token
string
|
Unique identifier of the transaction. Allowable Values: Format: UUID |
end_index
integer
|
The sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
Retrieve program transfer
Copy section link
Action: GET
Endpoint: /programtransfers/{token}
Use this endpoint to retrieve a specific program transfer.
Include the program transfer token path parameter to specify the program transfer to retrieve.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
Program transfer token Allowable Values: Existing program transfer token |
Response body
Copy section link
| Fields | Description |
|---|---|
amount
decimal
|
Amount of program transfer. This field is returned if it exists in the resource. Allowable Values: Format: 0.00 |
business_token
string
|
The unique identifier of the business. This field is returned if it exists in the resource. Allowable Values: 1–36 chars |
created_time
datetime
|
The date and time when the program transfer object was created, in UTC.
This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
currency_code
string
|
The three-digit ISO 4217 currency code. This field is returned if it exists in the resource. Allowable Values: A valid three-digit ISO 4217 currency code |
fees
array of objects
|
Contains attributes that define characteristics of one or more fees. This array is returned if it exists in the resource. Allowable Values: A valid |
fees[].fee
object
|
Contains details about the fee. Allowable Values: A valid |
fees[].fee.active
boolean
|
Indicates whether the fee is active. Allowable Values:
|
fees[].fee.amount
decimal
|
The amount of the fee. Allowable Values: Format: 0.00 |
fees[].fee.created_time
datetime
|
The date and time when the Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
fees[].fee.currency_code
string
|
The three-digit ISO 4217 currency code. Allowable Values: A valid three-digit ISO 4217 currency code |
fees[].fee.last_modified_time
datetime
|
The date and time when the Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
fees[].fee.name
string
|
The name of the Allowable Values: 50 char max |
fees[].fee.real_time_assessment
object
|
Controls the assessment of real-time fees. This field is returned if it exists in the resource. Allowable Values: A valid |
fees[].fee.real_time_assessment.domestic_enabled
boolean
|
Enables fee assessments where the origin of the transaction acquirer is inside the US. This field is returned if it exists in the resource. Allowable Values:
|
fees[].fee.real_time_assessment.international_enabled
boolean
|
Enables fee assessments where the origin of the transaction acquirer is outside the US. This field is returned if it exists in the resource. Allowable Values:
|
fees[].fee.real_time_assessment.transaction_type
string
|
Indicates the type of transactions on which the fee is assessed. This field is returned if it exists in the resource. Allowable Values:
|
fees[].fee.tags
string
|
Descriptive metadata about the fee. This field is returned if it exists in the resource. Allowable Values: 255 char max |
fees[].fee.token
string
|
The unique identifier of the fee. This field is returned if it exists in the resource. Allowable Values: 36 char max |
fees[].memo
string
|
Additional text that describes the fee. This field is returned if it exists in the resource. Allowable Values: 1–99 chars |
fees[].tags
string
|
Comma-delimited list of tags describing the fee. This field is returned if it exists in the resource. Allowable Values: 255 char max |
fees[].token
string
|
The unique identifier of the fee. Send a Allowable Values: 1–36 chars |
fees[].transaction_token
string
|
Unique identifier of the transaction. Allowable Values: Format: UUID |
Create program transfer type
Copy section link
Action: POST
Endpoint: /programtransfers/types
Use this endpoint to create a program transfer type. Add the program transfer details to the body of the request in JSON format.
You are required to pass in a program_funding_source_token to associate a program funding source with the program transfer type.
You must therefore create a program funding source before creating a program transfer type.
Request body
Copy section link
| Fields | Description |
|---|---|
memo
string
|
Memo or note describing the program transfer type. Allowable Values: 1–99 chars |
program_funding_source_token
string
|
Identifies the program funding source to which program transfers will be credited. Send a Allowable Values: 1–36 chars |
tags
string
|
Comma-delimited list of tags describing the program transfer type. Allowable Values: 1–255 chars |
token
string
|
If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 1–36 chars |
Response body
Copy section link
| Fields | Description |
|---|---|
created_time
datetime
|
The date and time when the program transfer type object was created, in UTC.
This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
last_modified_time
datetime
|
The date and time when the program transfer type object was last modified, in UTC.
This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
memo
string
|
Memo or note describing the program transfer type. This field is returned if it exists in the resource. Allowable Values: 99 char max |
program_funding_source_token
string
|
Identifies the program funding source to which program transfers will be credited. Allowable Values: Token of existing program funding source |
tags
string
|
Comma-delimited list of tags describing the program transfer type. This field is returned if it exists in the resource. Allowable Values: 255 char max |
token
string
|
The unique identifier of the program transfer type request object. Allowable Values: 36 char max |
List program transfer types
Copy section link
Action: GET
Endpoint: /programtransfers/types
Use this endpoint to list all program transfer types.
This endpoint supports field filtering, pagination, and sorting.
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of program transfer types to retrieve. Allowable Values: 1-10 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: A comma-delimited list of fields, or blank |
sort_by
string
|
Field on which to sort.
Use any field in the resource model, or one of the system fields Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of program transfer resources to retrieve. Allowable Values: 1-10 |
data
array of objects
|
An array of program transfer types. This array is returned if it exists in the resource. Allowable Values: A valid |
data[].created_time
datetime
|
The date and time when the program transfer type object was created, in UTC.
This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
data[].last_modified_time
datetime
|
The date and time when the program transfer type object was last modified, in UTC.
This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
data[].memo
string
|
Memo or note describing the program transfer type. This field is returned if it exists in the resource. Allowable Values: 99 char max |
data[].program_funding_source_token
string
|
Identifies the program funding source to which program transfers will be credited. Allowable Values: Token of existing program funding source |
data[].tags
string
|
Comma-delimited list of tags describing the program transfer type. This field is returned if it exists in the resource. Allowable Values: 255 char max |
data[].token
string
|
The unique identifier of the program transfer type request object. Allowable Values: 36 char max |
end_index
integer
|
The sort order index of the last resource in the returned array. This field is returned if it exists in the resource. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
Update program transfer type
Copy section link
Action: PUT
Endpoint: /programtransfers/types/{type_token}
Use this endpoint to update a program transfer type.
Include the type_token path parameter to indicate the program transfer type to update.
Add the modified detail parameters to the body of the request in JSON format.
Only values of parameters in the request are modified; all others are left unchanged.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
type_token
string
|
The unique identifier of the program transfer type. Allowable Values: Existing program transfer type token |
Request body
Copy section link
| Fields | Description |
|---|---|
memo
string
|
Memo or note describing the program transfer type. Allowable Values: 1–99 chars |
program_funding_source_token
string
|
Identifies the program funding source to which program transfers will be credited. Send a Allowable Values: 1–36 chars |
tags
string
|
Comma-delimited list of tags describing the program transfer type. Allowable Values: 1–255 chars |
token
string
|
If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 1–36 chars |
Response body
Copy section link
| Fields | Description |
|---|---|
created_time
datetime
|
The date and time when the program transfer type object was created, in UTC.
This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
last_modified_time
datetime
|
The date and time when the program transfer type object was last modified, in UTC.
This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
memo
string
|
Memo or note describing the program transfer type. This field is returned if it exists in the resource. Allowable Values: 99 char max |
program_funding_source_token
string
|
Identifies the program funding source to which program transfers will be credited. Allowable Values: Token of existing program funding source |
tags
string
|
Comma-delimited list of tags describing the program transfer type. This field is returned if it exists in the resource. Allowable Values: 255 char max |
token
string
|
The unique identifier of the program transfer type request object. Allowable Values: 36 char max |
Retrieve program transfer type
Copy section link
Action: GET
Endpoint: /programtransfers/types/{type_token}
Use this endpoint to retrieve a specific program transfer.
Include the type_token path parameter to indicate the program transfer type to return.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
type_token
string
|
The unique identifier of the program transfer type. Allowable Values: Existing program transfer type token |
Response body
Copy section link
| Fields | Description |
|---|---|
created_time
datetime
|
The date and time when the program transfer type object was created, in UTC.
This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
last_modified_time
datetime
|
The date and time when the program transfer type object was last modified, in UTC.
This field is returned if it exists in the resource. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
memo
string
|
Memo or note describing the program transfer type. This field is returned if it exists in the resource. Allowable Values: 99 char max |
program_funding_source_token
string
|
Identifies the program funding source to which program transfers will be credited. Allowable Values: Token of existing program funding source |
tags
string
|
Comma-delimited list of tags describing the program transfer type. This field is returned if it exists in the resource. Allowable Values: 255 char max |
token
string
|
The unique identifier of the program transfer type request object. Allowable Values: 36 char max |