GET
/transactions/{userId}/payment-purposesPayment Purpose
Returns the list of available payment purpose codes for a user. Optionally filtered by payment type.
Path variables
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
userId | string | Required | — | Unique user ID. |
Query parameters
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
paymentType | string | Optional | ACH | WIRE | INTERNATIONAL_WIRE | FVNet | STABLECOIN_WITHDRAW | CROSS_BORDER_AED_DOMESTIC | CROSS_BORDER_AED_WIRE | CROSS_BORDER_ARS_DOMESTIC | CROSS_BORDER_BRL_DOMESTIC | CROSS_BORDER_CAD_DOMESTIC | CROSS_BORDER_CAD_WIRE | CROSS_BORDER_SEPA | CROSS_BORDER_EUR_WIRE | CROSS_BORDER_FASTER_PAYMENTS | CROSS_BORDER_GBP_WIRE | CROSS_BORDER_HKD_DOMESTIC | CROSS_BORDER_HKD_WIREY | CROSS_BORDER_JPY_DOMESTIC | CROSS_BORDER_JPY_WIRE | CROSS_BORDER_CLABE | CROSS_BORDER_MXN_WIRE | CROSS_BORDER_SGD_DOMESTIC | CROSS_BORDER_SGD_WIRE | CROSS_BORDER_ZAR_DOMESTIC | CROSS_BORDER_ZAR_WIRE | Filter purposes by payment type. |
Headers
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
session-token | string | Required | — | SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header. |
Response
| Field | Type | Possible values | Description |
|---|---|---|---|
ResponseCode | integer | 200 | 201 | 204 | 301 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 503 | API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized). |
ResponseMessage | string | Success | Created | NoContent | BadRequest | Unauthorized | Forbidden | NotFound | Gone | UnprocessableContent | ServerError | ResourceMoved | ServiceUnAvailable | UnProcessableEntity | Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome. |
ResponseData | object | Please refer to below example for response body | Available payment purpose codes and their display labels. |
Example response
{
"ResponseCode": 200,
"ResponseMessage": "Success",
"ResponseData": {
"Fields": [
{
"Name": "Payment Purpose",
"Required": true,
"Type": "SingleSelection",
"PossibleValues": [
{
"label": "Asset Purchase",
"value": "Asset_Purchase"
},
{
"label": "Contract Payment",
"value": "Contract_Payment"
},
{
"label": "Dividends",
"value": "dividends"
},
{
"label": "Education Payment",
"value": "Education_Payment"
},
{
"label": "Gift/Donation",
"value": "gift_donation"
},
{
"label": "Investment Purchase",
"value": "Investment_Purchase"
},
{
"label": "Invoice Payment",
"value": "Invoice_Payment"
},
{
"label": "Loan Payments",
"value": "Loan_Payments"
},
{
"label": "Materials Purchase",
"value": "Materials_Purchase"
},
{
"label": "Mortgage Payments",
"value": "Mortgage_Payments"
},
{
"label": "Payroll",
"value": "Payroll"
},
{
"label": "Personal/Family Payment",
"value": "Personal_Family_Payment"
},
{
"label": "Professional Service Payments",
"value": "Professional_Service_Payments"
},
{
"label": "Reimbursements",
"value": "reimbursements"
},
{
"label": "Remittance",
"value": "remittance"
},
{
"label": "Rent/Utility Payments",
"value": "Rent_Utility_Payments"
},
{
"label": "Savings",
"value": "Savings"
},
{
"label": "Settlement (Trade)",
"value": "settlement_trade"
},
{
"label": "Tax Payments",
"value": "Tax_Payments"
},
{
"label": "Treasury Movement",
"value": "treasury_movement"
},
{
"label": "Other (describe below)",
"value": "Other"
}
]
}
]
}
}Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.