Server API version 1.0
Go

Results for

icon-search-large No search results yet
Enter your search query above

Cancel payout

POST https://{domainname}/v1/{merchantId}/payouts/{payoutId}/cancel

Payouts

Our payout service allows you to easily transfer money directly 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 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: Go

This scenario you will probably use the most

  • err := client.Merchant("merchantId").Payouts().Cancel("payoutId", nil)
    

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 requirederrors.ErrorResponse

If the payout cancellation could not be performed a HTTP status 402 can be returned.

     Property Type Required Description
errorId string yes

Unique reference, for debugging purposes, of this error response

array yes
List of one or more errors
object no SDK object type: errors.APIError
category string no

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.

code string yes

Error code

httpStatusCode integer no

HTTP status code for this error that can be used to determine the type of error

id string no

ID of the error. This is a short human-readable message that briefly describes the error.

message string no

Human-readable error message that is not meant to be relayed to consumer as it might tip off people who are trying to commit fraud

propertyName string no

Returned 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:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.

requestId string no

ID of the request that can be used for debugging purposes

Response example

SDK: Go

This scenario you will probably use the most

  • {
        "errorId" : "657b10da-d2f9-4088-a948-bf190ef516b1-000001cd",
        "errors" : [
            {
                "code" : "400210",
                "message" : "UNKNOWN_ORDER_OR_NOT_CANCELLABLE"
            }
        ]
    }
    
icon_top_1