/
5 minute read
April 11, 2023

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

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

Fields Description

account_token

string
Required

The 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 credit balance refund.

Allowable Values:

36 char max

method

string
Required

Method of the refund.

Allowable Values:

CHECK

amount

decimal
Required

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
Required

Description for the credit balance refund.

Allowable Values:

255 char max

currency_code

string
Required

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

Sample request body

JSON
Copied

Is this helpful?

Yes
No

Response body

Fields Description

token

string
Returned

Unique identifier of the credit balance refund.

If in the detail_object, unique identifier of the detail object.

Allowable Values:

36 char max

account_token

string
Returned

Unique identifier of the credit account that needs the credit balance refund.

Allowable Values:

36 char max

Existing account token

status

string
Returned

Current status of the payment or refund.

Allowable Values:

INITIATED, PENDING, PROCESSING, SUBMITTED, CANCELLED, COMPLETED, RETURNED, REFUNDED, SYS_ERROR, ACH_ERROR

method

string
Returned

Method of the refund.

Allowable Values:

CHECK

amount

decimal
Returned

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
Returned

Description for the credit credit balance refund.

Allowable Values:

255 char max

created_time

datetime
Returned

Date and time when the credit balance refund was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

updated_time

datetime
Returned

Date and time when the credit balance refund was last updated.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

Sample response body

JSON
Copied

Is this helpful?

Yes
No

Subscribe to our developer newsletter