Balance Refunds
Use the credit balance refunds endpoint to issue a credit balance refund on credit account. When an account balance is negative, a balance refund can be issued to bring the balance closer to 0.
Creating a balance refund triggers the creation of a journal entry belonging to the BALANCE_REFUND group.
For more on balance refund journal entries, see Balance refunds in the About Credit Account Journal Entries guide.
Create balance refund
Copy section link
Action: POST
Endpoint: /credit/accounts/{account_token}/creditbalancerefunds
Create a new balance refund, which can be issued to the account holder if their credit account balance is negative.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which you want to create a balance refund. Send a Allowable Values: Existing account token |
Request body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit balance refund. Allowable Values: 36 char max |
method
string
|
Method of the refund. Allowable Values:
|
amount
decimal
|
Amount of the credit balance 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 |
description
string
|
Description for the credit balance refund. Allowable Values: 255 char max |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit balance refund. If in the Allowable Values: 36 char max |
account_token
string
|
Unique identifier of the credit account that needs the credit balance refund. Allowable Values: 36 char max Existing account token |
status
string
|
Current status of the payment or refund. Allowable Values:
|
method
string
|
Method of the refund. Allowable Values:
|
amount
decimal
|
Amount of the credit balance 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 |
description
string
|
Description for the credit credit balance refund. Allowable Values: 255 char max |
created_time
datetime
|
Date and time when the credit balance refund was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
updated_time
datetime
|
Date and time when the credit balance refund was last updated. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |