Skip to main content
Use the payments endpoints to create and retrieve payments made on a credit account, release payment holds, or transition payment statuses. A payment is an amount paid toward an account balance to reduce the total amount owed on the account. For more on payments, see About Credit Account Payments. To receive webhook notifications when ACH payment transition events occur, see Credit account payment transition events in Event Types. Creating a payment triggers the creation of a journal entry belonging to the PAYMENT group. For more on payment journal entries, see Payments in the About Credit Account Journal Entries guide.

Create account payment

Action: POST
Endpoint: /credit/accounts/{account_token}/payments
Create a new payment to apply toward a credit account’s balance.

URL path parameters

Request body

Sample request body

JSON

Response body

Sample response body

JSON

List account payments

Action: GET
Endpoint: /credit/accounts/{account_token}/payments
Retrieve an array of payments on a credit account. This endpoint supports sorting and pagination.

URL path parameters

URL query parameters

Response body

Sample response body

JSON

Retrieve account payment

Action: GET
Endpoint: /credit/accounts/{account_token}/payments/{payment_token}
Retrieve a payment for a credit account.

URL path parameters

Response body

Sample response body

JSON

Release payment hold

Action: POST
Endpoint: /credit/accounts/{account_token}/payments/{payment_token}/releasehold
Manually release a payment hold on a credit account.

URL path parameters

Response body

Sample response body

JSON

Transition account payment status

Action: POST
Endpoint: /credit/accounts/{account_token}/payments/{payment_token}/transitions
Transition a credit account payment’s status to a new status.

URL path parameters

Request body

Sample request body

JSON

Response body

Resend credit event notification

Action: POST
Endpoint: /credit/webhooks/{event_type}/{resource_token}
Resends a credit event notification to your webhook endpoint. Although you send this request as a POST, all parameters are passed in the URL and the body is empty. The event notification is resent to your webhook endpoint and also returned in the response to this request. For details on how to configure your webhook endpoint, see the About Webhooks tutorial. For the complete /webhooks endpoint reference, see Webhooks.

URL path parameters

Response body

Sample response body

The following code block shows a sample of a resent creditaccounttransitions event.
JSON
The following code block shows a sample of a resent creditaccountstatements event.
JSON
The following code block shows a sample of a resent creditjournalentries event.
JSON
The following code block shows a sample of a resent creditledgerentries event.
JSON
The following code block shows a sample of a resent creditpaymenttransitions event.
JSON
The following code block shows a sample of a resent creditdelinquencytransitions event.
JSON
The following code block shows a sample of a resent substatus event.
JSON
The following code block shows a sample of a resent accountsignupbonus event.
JSON