Payments
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
Copy section link
Action: POST
Endpoint: /credit/accounts/{account_token}/payments
Create a new payment to apply toward a credit account’s balance.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which to create a payment. Send a Allowable Values: Existing account token |
Request body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the payment. Allowable Values: 36 char max |
method
string
|
Method of payment. Allowable Values:
|
payment_source_token
string
|
Unique identifier of the payment source. Required for ACH payments. Allowable Values: Existing payment source token |
amount
decimal
|
Amount of the payment. Allowable Values: 0 min |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
impact_time
datetime
|
Date and time when the payment impacts the account balance and fee calculations. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
description
string
|
Description of the payment. Allowable Values: 255 char max |
metadata
string
|
Customer-defined additional information about the payment (for example, a check number). Allowable Values: 255 char max |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the payment. If in the Allowable Values: 36 char max |
account_token
string
|
Unique identifier of the credit account on which the payment is made. Allowable Values: 36 char max Existing account token |
method
string
|
Method of payment. Allowable Values:
|
payment_source_token
string
|
Unique identifier of the payment source. Required for ACH payments. Allowable Values: Existing payment source token |
payment_schedule_token
string
|
Unique identifier of the payment schedule. Allowable Values: 36 char max |
amount
decimal
|
Total amount of the payment. Allowable Values: 0 min |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
status
string
|
Current status of the payment or refund. Allowable Values:
|
description
string
|
Description of the payment. Allowable Values: 255 char max |
metadata
string
|
Customer-defined additional information about the payment (for example, a check number). Allowable Values: 255 char max |
hold_days
integer
|
After a payment completes, the number of days to hold the available credit on the account before increasing it. Allowable Values: Any integer |
hold_end_time
datetime
|
Date and time when the available credit hold is released. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
is_manually_released
boolean
|
Whether the available credit hold was manually released for this payment. Allowable Values:
Default value: |
on_hold
boolean
|
Whether the available credit is on hold for this payment. Allowable Values:
Default value: |
returned_details
object
|
Contains information on a returned payment. Allowable Values: Existing |
returned_details.return_code
string
|
Return code for the returned payment. For more, see NACHA ACH return codes. Allowable Values: The return code |
returned_details.return_reason
string
|
Reason the payment was returned. For more, see NACHA ACH return codes. Allowable Values: The return reason |
refund_details
object
|
Contains details for a refund. Allowable Values: Existing |
refund_details.method
string
|
Method of the refund. Allowable Values:
|
refund_details.description
string
|
Description of the refund. Allowable Values: 255 char max |
refund_details.status
string
|
Current status of the refund. Allowable Values:
|
created_time
datetime
|
Date and time when the payment was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
updated_time
datetime
|
Date and time when the payment was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
transitions
array of objects
|
Contains one or more Allowable Values: One or more |
transitions[].token
string
|
Unique identifier of the payment status transition. Allowable Values: 36 char max |
transitions[].account_token
string
|
Unique identifier of the credit account on which you want to transition a payment status. Allowable Values: Existing account token |
transitions[].payment_token
string
|
Unique identifier of the payment whose status you want to transition. Allowable Values: Existing payment token |
transitions[].status
string
|
New status to which the payment is transitioned.
Allowable Values:
|
transitions[].created_time
datetime
|
Date and time when the payment transition was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
List account payments
Copy section link
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
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which to retrieve payments. Send a Allowable Values: Existing account token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
start_date
date
|
Beginning of the date range of the payments to return. Allowable Values: Example: 2019-01-01 |
end_date
date
|
End of the date range of the payments to return. Allowable Values: Example: 2019-01-01 |
count
integer
|
The number of resources to retrieve. Allowable Values: 1–100 |
start_index
integer
|
Sort order index of the first resource in the returned array. Allowable Values: 0 min |
sort_by
string
|
Field on which to sort.
Prefix the field name with a hyphen ( NOTE:
You must sort using system field names such as Allowable Values:
|
statuses
array of strings
|
An array of statuses by which to filter payments. Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
Number of resources returned. Allowable Values: 1-10 |
start_index
integer
|
Sort order index of the first resource in the returned array. Allowable Values: Any integer |
end_index
integer
|
Sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
data
array of objects
|
Contains one or more payments on a credit account. Allowable Values: One or more payment objects |
data[].token
string
|
Unique identifier of the payment. If in the Allowable Values: 36 char max |
data[].account_token
string
|
Unique identifier of the credit account on which the payment is made. Allowable Values: 36 char max Existing account token |
data[].method
string
|
Method of payment. Allowable Values:
|
data[].payment_source_token
string
|
Unique identifier of the payment source. Required for ACH payments. Allowable Values: Existing payment source token |
data[].payment_schedule_token
string
|
Unique identifier of the payment schedule. Allowable Values: 36 char max |
data[].amount
decimal
|
Total amount of the payment. Allowable Values: 0 min |
data[].currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
data[].status
string
|
Current status of the payment or refund. Allowable Values:
|
data[].description
string
|
Description of the payment. Allowable Values: 255 char max |
data[].metadata
string
|
Customer-defined additional information about the payment (for example, a check number). Allowable Values: 255 char max |
data[].hold_days
integer
|
After a payment completes, the number of days to hold the available credit on the account before increasing it. Allowable Values: Any integer |
data[].hold_end_time
datetime
|
Date and time when the available credit hold is released. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].is_manually_released
boolean
|
Whether the available credit hold was manually released for this payment. Allowable Values:
Default value: |
data[].on_hold
boolean
|
Whether the available credit is on hold for this payment. Allowable Values:
Default value: |
data[].returned_details
object
|
Contains information on a returned payment. Allowable Values: Existing |
data[].returned_details.return_code
string
|
Return code for the returned payment. For more, see NACHA ACH return codes. Allowable Values: The return code |
data[].returned_details.return_reason
string
|
Reason the payment was returned. For more, see NACHA ACH return codes. Allowable Values: The return reason |
data[].refund_details
object
|
Contains details for a refund. Allowable Values: Existing |
data[].refund_details.method
string
|
Method of the refund. Allowable Values:
|
data[].refund_details.description
string
|
Description of the refund. Allowable Values: 255 char max |
data[].refund_details.status
string
|
Current status of the refund. Allowable Values:
|
data[].created_time
datetime
|
Date and time when the payment was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].updated_time
datetime
|
Date and time when the payment was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].transitions
array of objects
|
Contains one or more Allowable Values: One or more |
data[].transitions[].token
string
|
Unique identifier of the payment status transition. Allowable Values: 36 char max |
data[].transitions[].account_token
string
|
Unique identifier of the credit account on which you want to transition a payment status. Allowable Values: Existing account token |
data[].transitions[].payment_token
string
|
Unique identifier of the payment whose status you want to transition. Allowable Values: Existing payment token |
data[].transitions[].status
string
|
New status to which the payment is transitioned.
Allowable Values:
|
data[].transitions[].created_time
datetime
|
Date and time when the payment transition was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Retrieve account payment
Copy section link
Action: GET
Endpoint: /credit/accounts/{account_token}/payments/{payment_token}
Retrieve a payment for a credit account.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which to retrieve a payment. Send a Allowable Values: Existing account token |
payment_token
string
|
The unique identifier of the payment to retrieve. Send a Allowable Values: Existing payment token |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the payment. If in the Allowable Values: 36 char max |
account_token
string
|
Unique identifier of the credit account on which the payment is made. Allowable Values: 36 char max Existing account token |
method
string
|
Method of payment. Allowable Values:
|
payment_source_token
string
|
Unique identifier of the payment source. Required for ACH payments. Allowable Values: Existing payment source token |
payment_schedule_token
string
|
Unique identifier of the payment schedule. Allowable Values: 36 char max |
amount
decimal
|
Total amount of the payment. Allowable Values: 0 min |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
status
string
|
Current status of the payment or refund. Allowable Values:
|
description
string
|
Description of the payment. Allowable Values: 255 char max |
metadata
string
|
Customer-defined additional information about the payment (for example, a check number). Allowable Values: 255 char max |
hold_days
integer
|
After a payment completes, the number of days to hold the available credit on the account before increasing it. Allowable Values: Any integer |
hold_end_time
datetime
|
Date and time when the available credit hold is released. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
is_manually_released
boolean
|
Whether the available credit hold was manually released for this payment. Allowable Values:
Default value: |
on_hold
boolean
|
Whether the available credit is on hold for this payment. Allowable Values:
Default value: |
returned_details
object
|
Contains information on a returned payment. Allowable Values: Existing |
returned_details.return_code
string
|
Return code for the returned payment. For more, see NACHA ACH return codes. Allowable Values: The return code |
returned_details.return_reason
string
|
Reason the payment was returned. For more, see NACHA ACH return codes. Allowable Values: The return reason |
refund_details
object
|
Contains details for a refund. Allowable Values: Existing |
refund_details.method
string
|
Method of the refund. Allowable Values:
|
refund_details.description
string
|
Description of the refund. Allowable Values: 255 char max |
refund_details.status
string
|
Current status of the refund. Allowable Values:
|
created_time
datetime
|
Date and time when the payment was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
updated_time
datetime
|
Date and time when the payment was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
transitions
array of objects
|
Contains one or more Allowable Values: One or more |
transitions[].token
string
|
Unique identifier of the payment status transition. Allowable Values: 36 char max |
transitions[].account_token
string
|
Unique identifier of the credit account on which you want to transition a payment status. Allowable Values: Existing account token |
transitions[].payment_token
string
|
Unique identifier of the payment whose status you want to transition. Allowable Values: Existing payment token |
transitions[].status
string
|
New status to which the payment is transitioned.
Allowable Values:
|
transitions[].created_time
datetime
|
Date and time when the payment transition was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Release payment hold
Copy section link
Action: POST
Endpoint: /credit/accounts/{account_token}/payments/{payment_token}/releasehold
Manually release a payment hold on a credit account.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account on which a payment hold is being released. Send a Allowable Values: Existing account token |
payment_token
string
|
The unique identifier of the payment currently on hold. Send a Allowable Values: Existing payment token |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the payment. If in the Allowable Values: 36 char max |
account_token
string
|
Unique identifier of the credit account on which the payment is made. Allowable Values: 36 char max Existing account token |
method
string
|
Method of payment. Allowable Values:
|
payment_source_token
string
|
Unique identifier of the payment source. Required for ACH payments. Allowable Values: Existing payment source token |
payment_schedule_token
string
|
Unique identifier of the payment schedule. Allowable Values: 36 char max |
amount
decimal
|
Total amount of the payment. Allowable Values: 0 min |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
status
string
|
Current status of the payment or refund. Allowable Values:
|
description
string
|
Description of the payment. Allowable Values: 255 char max |
metadata
string
|
Customer-defined additional information about the payment (for example, a check number). Allowable Values: 255 char max |
hold_days
integer
|
After a payment completes, the number of days to hold the available credit on the account before increasing it. Allowable Values: Any integer |
hold_end_time
datetime
|
Date and time when the available credit hold is released. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
is_manually_released
boolean
|
Whether the available credit hold was manually released for this payment. Allowable Values:
Default value: |
on_hold
boolean
|
Whether the available credit is on hold for this payment. Allowable Values:
Default value: |
returned_details
object
|
Contains information on a returned payment. Allowable Values: Existing |
returned_details.return_code
string
|
Return code for the returned payment. For more, see NACHA ACH return codes. Allowable Values: The return code |
returned_details.return_reason
string
|
Reason the payment was returned. For more, see NACHA ACH return codes. Allowable Values: The return reason |
refund_details
object
|
Contains details for a refund. Allowable Values: Existing |
refund_details.method
string
|
Method of the refund. Allowable Values:
|
refund_details.description
string
|
Description of the refund. Allowable Values: 255 char max |
refund_details.status
string
|
Current status of the refund. Allowable Values:
|
created_time
datetime
|
Date and time when the payment was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
updated_time
datetime
|
Date and time when the payment was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
transitions
array of objects
|
Contains one or more Allowable Values: One or more |
transitions[].token
string
|
Unique identifier of the payment status transition. Allowable Values: 36 char max |
transitions[].account_token
string
|
Unique identifier of the credit account on which you want to transition a payment status. Allowable Values: Existing account token |
transitions[].payment_token
string
|
Unique identifier of the payment whose status you want to transition. Allowable Values: Existing payment token |
transitions[].status
string
|
New status to which the payment is transitioned.
Allowable Values:
|
transitions[].created_time
datetime
|
Date and time when the payment transition was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Transition account payment status
Copy section link
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
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which you want to transition a payment status. Send a Allowable Values: Existing account token |
payment_token
string
|
The unique identifier of the payment whose status you want to transition. Send a Allowable Values: Existing payment token |
Request body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the payment status transition. Allowable Values: 36 char max |
status
string
|
Current status of the payment or refund. Allowable Values:
|
refund_details
object
|
Contains details for a refund. Allowable Values: Existing |
refund_details.method
string
|
Method of the refund. Allowable Values:
|
refund_details.description
string
|
Description of the refund. Allowable Values: 255 char max |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the payment status transition. Allowable Values: 36 char max |
account_token
string
|
Unique identifier of the credit account on which you want to transition a payment status. Allowable Values: Existing account token |
payment_token
string
|
Unique identifier of the payment whose status you want to transition. Allowable Values: Existing payment token |
status
string
|
New status to which the payment is transitioned.
Allowable Values:
|
created_time
datetime
|
Date and time when the payment transition was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Resend credit event notification
Copy section link
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
Copy section link
| Fields | Description |
|---|---|
event_type
string
|
Specifies the type of event you want to resend. Allowable Values:
|
resource_token
string
|
The unique identifier of the resource for which you want to resend a notification. Send a Send a Send a Send a Send a Send a Allowable Values: Existing journal entry token, ledger entry token, account transition token, payment transition token, statement summary token, or delinquency transition token |
Response body
Copy section link
| Fields | Description |
|---|---|
unused
string
|
The event notification that was resent to your webhook endpoint. Allowable Values: Valid event notification |
Sample response body
Copy section link
The following code block shows a sample of a resent creditaccounttransitions event.
The following code block shows a sample of a resent creditaccountstatements event.
The following code block shows a sample of a resent creditjournalentries event.
The following code block shows a sample of a resent creditledgerentries event.
The following code block shows a sample of a resent creditpaymenttransitions event.
The following code block shows a sample of a resent creditdelinquencytransitions event.