POST////
Create a new refund, which you can issue to the account holder if their credit account balance is negative.
URL path parameters
| Fields | Description |
|---|---|
| account_token string Required | Unique identifier of the credit account for which you want to create a balance refund. Send a GET request to /credit/accounts to retrieve existing credit account tokens.Allowable Values: Existing account token |
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the refund. Allowable Values: 36 char max |
| method string Required | Payment instrument used to issue the refund. Allowable Values: ACH, CHECK |
| type string Required | Type of refund. Allowable Values: PAYMENT_REFUND, CREDIT_BALANCE_REFUND |
| payment_source_token string Optional | Unique identifier of the payment source that receives the refunded amount. Allowable Values: 36 char max Existing payment source token |
| amount decimal Optional | Amount of the refund. The maximum refund amount is the amount that brings the account balance to $0. For example, $4000 is the maximum refund amount for a -$4000 account balance. Allowable Values: 0.01 min |
| currency_code string Optional | Valid three-digit ISO 4217 currency code. Allowable Values: USD |
| description string Optional | Description of the refund. Allowable Values: 255 char max |
Sample request body
JSON
{
"method": "ACH",
"type": "CREDIT_BALANCE_REFUND",
"payment_source_token": "my_payment_funding_source_token",
"description": "credit refund"
}
Response body
| Fields | Description |
|---|---|
| token string Returned | Unique identifier of the refund. Allowable Values: 36 char max |
| account_token string Returned | Unique identifier of the account for which the refund is issued. Allowable Values: 36 char max Existing account token |
| status string Returned | Current status of the refund. Allowable Values: INITIATED, PENDING, PROCESSING, SUBMITTED, CANCELLED, COMPLETED, RETURNED |
| method string Returned | Payment instrument used to issue the refund. Allowable Values: ACH, CHECK |
| type string Returned | Type of refund. Allowable Values: PAYMENT_REFUND, CREDIT_BALANCE_REFUND |
| payment_source_token string Conditionally returned | Unique identifier of the payment source that receives the refunded amount. Allowable Values: 36 char max Existing payment source token |
| amount decimal Returned | Amount of the refund. The maximum refund amount is the amount that brings the account balance to $0. For example, $4000 is the maximum refund amount for a -$4000 account balance. Allowable Values: 0.01 min |
| currency_code string Returned | Valid three-digit ISO 4217 currency code. Allowable Values: USD |
| description string Conditionally returned | Description of the refund. Allowable Values: 255 char max |
| created_time datetime Returned | Date and time when the refund was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| updated_time datetime Returned | Date and time when the refund was last updated. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"token": "credit_balance_refund_token1234",
"account_token": "my_account_token_12",
"status": "PENDING",
"method": "ACH",
"type": "CREDIT_BALANCE_REFUND",
"payment_source_token": "my_payment_funding_source_token",
"amount": 10,
"currency_code": "USD",
"description": "credit balance refund",
"created_time": "2025-01-02T20:17:28Z",
"updated_time": "2025-01-02T20:17:28Z"
}