Skip to main content
The /gpaorders endpoint moves funds from a funding source into an account holder’s general-purpose account (GPA). GPA orders can also be used to move funds from an account holder’s funding source into your program’s fee account. GPA orders can be funded by the account holder or your program.

Create GPA order

Action: POST
Endpoint: /gpaorders
Use this endpoint to create an order to fund an account holder’s GPA. You can assess a fee while funding a GPA by using the optional fees array to attach one or more fee resources to the GPA order. When you create a GPA order, the GPA is first credited for the fees, then debited at funding time.

Request body

Sample request body

JSON

Response body

Sample response body

JSON

Retrieve GPA order

Action: GET
Endpoint: /gpaorders/{token}
Use this endpoint to retrieve a GPA order.

URL path parameters

Response body

Sample response body

JSON

Create GPA unload

Action: POST
Endpoint: /gpaorders/unloads
Use this endpoint to unload a GPA order. Unloading a GPA order returns funds to the funding source. A GPA unload must be tied to an original GPA order and can be used to return the amount of the original order or a lesser amount.

Request body

Sample request body

JSON

Response body

Sample response body

JSON

List GPA unloads

Action: GET
Endpoint: /gpaorders/unloads
Use this endpoint to list all GPA unloads or GPA unloads associated with a specific user or business. This endpoint supports field filtering and pagination.

URL query parameters

Response body

Sample response body

JSON

Retrieve GPA unload

Action: GET
Endpoint: /gpaorders/unloads/{unload_token}
Use this endpoint to retrieve a specific GPA unload.

URL path parameters

Response body

Sample response body

JSON