💸Withdrawal/Payout

The payout operation allows funds to be transferred to a specified destination, including various methods such as cards, IBAN or crypto wallets .

Supported Payout Methods

  • Card Payout to a card.

  • IBAN Payout to an International Bank Account Number (IBAN).

  • Crypto Wallet Payout to a cryptocurrency wallet, supporting various blockchain networks.

Payout Flow

  1. Initiate Payout: Submit a request to transfer funds to the specified payout method.

  2. Validation: The system validates the provided payout details (card number, IBAN, or wallet address).

  3. Processing: Funds are processed and transferred to the destination account.

  4. Notification: If webhook settings specified, webhook is sent for each status transition. Webhook body represents payment model. Please refer to webhook section to get more details.

If no webhook settings specified, you can retrieve payment status via GET endpoint

Example API Request (See the API reference for more examples)

{
    "currency": "EUR",
    "method": "CC_VISAMC",
    "amount": 100,
    "cardNumber": "1234123412341234",
    "clientOrderId": "1234567890",
    "firstName": "John",
    "lastName": "Doe",
    "phoneNumber": "123123123"
}

Example API Request using prefetched payment method id

  1. Fetch payment methods, e.g. to perform crypto BITCOIN/BTC/PAYOUT:

    [
      {
        "blockchain": "BITCOIN",
        "currency": "BTC",
        "fixed": 0.0001,
        "hasNetworkFee": true,
        "id": "PMD-2eb51bd4-6117-437b-b933-502538a9662a",
        "maxLimit": 10,
        "methodKey": "CRYPTOCOIN",
        "minFeeAmount": 1,
        "minFeeCurrency": "EUR",
        "minLimit": 0.0001,
        "name": "bitcoin payin",
        "orderType": "PAYOUT",
        "percent": 0.1,
        "productType": "PAYMENT",
        "properties": {
          "optional": [
            "comment"
          ],
          "required": [
            "amount",
            "cryptoAddress"
          ]
        },
        "scale": 6,
        "verificationLevel": 3
      }
    ]
  2. Perform proper payout call

    {
        "paymentMethodId": "PMD-2eb51bd4-6117-437b-b933-502538a9662a",
        "amount": 0.1,
        "cryptoAddress": "0x74d94632c97f30f5ae124ad25c12c47a27558009"
    }

Last updated