Sign in

v1

latestOpenAPI 3.1.02026-07-26490301.4 KB
Payout

Payout

post/payout

Headers

X-Request-IDstring

Unique ID of request

Request body

consumerIdstring

Gateway consumer ID (user ID)

paymentAccountIdstring uuid

ID of the encoded user payment details

siteIdstring

Payout will be linked to the passed <b>siteId</b>, otherwise – to the first merchant site

amountnumber double required

Amount of operation

currencystring ISO3 required

Operation currency. If your currency is not supported, we will automatically convert it to USD

metadataobject

Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal

Example request

{
  "consumerId": "41098035",
  "paymentAccountId": "d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb",
  "siteId": 983759353,
  "amount": 9.99,
  "currency": "USD",
  "url": {
    "ipnUrl": "https://google.com/gateway/webhook/245252525252525"
  },
  "metadata": {
    "foo": "bar"
  }
}

Response

Created

metadataobject

Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal

Example response

{
  "payment": {
    "description": "APPROVED",
    "action": "charge",
    "mode": "payout",
    "status": "success",
    "amount": 9.99,
    "currency": "USD",
    "transactionId": "12345",
    "source": {
      "method": "card",
      "number": "402400****6348",
      "brand": "visa"
    }
  },
  "consumer": {
    "externalId": "14253ms92m0as",
    "email": "jonny.sonny@google.com",
    "phone": "+1987654320",
    "country": "GBR",
    "zip": "36101"
  },
  "metadata": {
    "foo": "bar"
  }
}