POST//
Send a POST request to the /directdeposits/stop-payment endpoint to create a stop payment order when your cardholder wants to halt a future payment. By creating a stop payment order, future matching transactions will be automatically declined by the Marqeta platform, with STOP_PAYMENT given as the decline reason in the transaction authorization.
Request body
| Fields | Description |
|---|---|
| token string Required | Unique identifier for each stop payment order. This value is not present in the direct deposit transition webhook. Allowable Values: 36 char max |
| ddaToken string Required | Unique identifier for the account in the system. This value is referred to as the direct_deposit_account_token in the direct deposit transition webhook.Allowable Values: 36 char max |
| amount decimal Optional | Amount of the stop payment order. This value is referred to as the amount in the direct deposit transition webhook.Allowable Values: decimal Format: 0.00 |
| companyId string Required | Alphanumeric code that identifies the direct deposit originator. This value is referred to as the company_identification in the direct deposit transition webhook.Allowable Values: 10 char max |
| companyName string Optional | Name of the direct deposit originator. This value is referred to as the company_name in the direct deposit transition webhook.Allowable Values: 16 char max |
| withdrawOrder boolean Optional | Flag indicating whether the stop payment order is withdrawn. This value is not present in the direct deposit transition webhook. Allowable Values: true, false |
Sample request body
JSON
{
"token": "00acce2b-cefg-45ab-8417-f8a62326c0d6",
"ddaToken" : "d5bd5921-048a-44c1-ba48-fe8ee0418f2d",
"amount": "50.75",
"companyId": "9876543210",
"companyName": "Friendship Inc.",
"withdrawOrder": false
}
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier for each stop payment order. Allowable Values: 36 char max |
| ddaToken string Returned | Unique identifier for the account in the system. Allowable Values: 36 char max |
| amount decimal Conditionally returned | Amount of the stop payment order. Allowable Values: decimal Format: 0.00 |
| companyId string Returned | Alphanumeric code that identifies the direct deposit originator. Allowable Values: 10 char max |
| companyName string Conditionally returned | Name of the direct deposit originator. Allowable Values: 16 char max |
| withdrawOrder boolean Conditionally returned | Flag indicating whether the stop payment order is withdrawn. Allowable Values: true, false |
| createdTime datetime Conditionally returned | Date and time when the resource was created. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ |
| lastModifiedTime datetime Conditionally returned | Date and time when the resource was last updated. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ |
Sample response body
JSON
{
"ddaToken": "d5bd5921-048a-44c1-ba48-fe8ee0418f2d",
"companyId": "9876543210",
"token": "00acce2b-cefg-45ab-8417-f8a62326c0d6",
"amount": 50.75,
"companyName": "Friendship Inc.",
"withdrawOrder": false,
"createdTime": "2025-01-31T18:46:46Z",
"lastModifiedTime": "2025-01-31T18:46:46Z"
}