POST//////
Transition a credit account payment’s status to a new status.
URL path parameters
| Fields | Description |
|---|---|
| account_token string Required | Unique identifier of the credit account for which you want to transition a payment status. Send a GET request to /credit/accounts to retrieve existing credit account tokens.Allowable Values: Existing account token |
| payment_token string Required | Unique identifier of the payment whose status you want to transition. Send a GET request to /credit/accounts/{account_token}/payments endpoint to retrieve existing payment tokens for a given account.Allowable Values: Existing payment token |
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the payment status transition. Allowable Values: 36 char max |
| status string Required | Current status of the payment or refund. Allowable Values: INITIATED, PENDING, PROCESSING, SUBMITTED, CANCELLED, COMPLETED, RETURNED, REFUNDED, SYS_ERROR, ACH_ERROR |
| refund_details object Optional | Contains details for a refund. Allowable Values: method, description |
| refund_details.method string Required | Payment instrument used to issue the refund. Allowable Values: ACH, CHECK |
| refund_details.description string Required | Description of the refund. Allowable Values: 255 char max |
| waive_returned_payment_fee boolean Optional | A value of true indicates that a returned payment fee should not be applied if one is applicable. This is false by default. This field is only considered during a transition to REFUNDEDAllowable Values: true, false |
Sample request body
JSON
{
"status": "RETURNED"
}
Response body
| Fields | Description |
|---|---|
| token string Returned | Unique identifier of the payment status transition. Allowable Values: 36 char max |
| account_token string Returned | Unique identifier of the credit account on which you want to transition a payment status. Allowable Values: Existing account token |
| payment_token string Returned | Unique identifier of the payment whose status you want to transition. Allowable Values: Existing payment 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 |
| created_time datetime Conditionally returned | Date and time when the payment transition was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |