Cancel payout
POST https://{domainname}/v1/{merchantId}/payouts/{payoutId}/cancel
Payouts
Our payout service allows you to easily transfer money directly, either to a card or into a bank account of your choice.
Before we can process your payout request you will need to pre-fund the total amount of money you want to payout.
For more information about card payouts please click here or for more information about bank payouts please click here.
Request
If you have no intention to process the payout request any further you can cancel it through this API.
The canceling of a payout can't be undone.
Payout only at status PENDING_APPROVAL and PAYOUT_REQUESTED can be cancelled.
Request example
SDK: Java
This scenario you will probably use the most
-
client.v1().merchant("merchantId").payouts().cancel("payoutId");
Responses
Please find below an overview of the possible responses.
Response 204 - No content
For every successfully cancelled payout resource a HTTP 204 response is returned.
Response 402 - Payment requiredErrorResponse
If the payout cancellation could not be performed a HTTP status 402 can be returned.
|
Properties
|
|||
| Property | Type | Required | Details |
|---|---|---|---|
| errorId | string | yes | read close |
|
close
DescriptionUnique reference, for debugging purposes, of this error response
|
|||
| array of object | yes | read close | |
|
close
DescriptionList of one or more errors
|
|||
| object | no | read close | |
| category | string | no | read close |
|
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
| code | string | yes | read close |
|
close
DescriptionError code
|
|||
| httpStatusCode | integer | no | read close |
|
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
| id | string | no | read close |
|
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
| message | string | no | read close |
|
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
| propertyName | string | no | read close |
|
close
DescriptionReturned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query. Some common examples:
|
|||
| requestId | string | no | read close |
|
close
DescriptionID of the request that can be used for debugging purposes
|
|||
Response example
SDK: Java
This scenario you will probably use the most
-
{ "errorId" : "657b10da-d2f9-4088-a948-bf190ef516b1-000001cd", "errors" : [ { "code" : "400210", "message" : "UNKNOWN_ORDER_OR_NOT_CANCELLABLE" } ] }