Payout

We are improving our documentation

We're currently working on improving this page to provide you with the best possible experience. Please bear with us while we make some changes.

Thank you for your patience!

A Payout credits the customer's account with the given amount.

Depending on the connector, either referenceUuid or cardData will be required.

note

This transaction method is only available for certain connectors and must be explicitly enabled by your integration engineer.

POST /transaction/{apiKey}/payout

Path parameters

Name	Type	Description
apiKey	requiredstring	API Key of Connector

Request body example

{
  "merchantTransactionId": "your-unique-identifier",
  "referenceUuid": "4d40738b1194869734f7",
  "amount": "9.99",
  "currency": "EUR",
  "successUrl": "https://shop.example.org/checkout/success",
  "cancelUrl": "https://shop.example.org/checkout/cancelled",
  "errorUrl": "https://shop.example.org/checkout/error",
  "callbackUrl": "https://api.example.org/callback",
  "description": "Purchase description shown on credit card statement.",
  "customer": {
    "identification": "616c6578-2e73-6d69-7468-406578616d70",
    "firstName": "Alex",
    "lastName": "Smith",
    "billingCountry": "US",
    "email": "[email protected]",
    "ipAddress": "198.51.100.123"
  }
}