Create payout

Request example (bank account)
POST /{{version}}/{{API_KEY}}/payouts
Content-Type: application/json
Host: {{API_URL}}
Authorization: Bearer {{ACCESS_TOKEN}}
{
  "order_id": "a17331a4",
  "provider": "PspName",
  "country": "BE",
  "currency": "EUR",
  "state": null,
  "amount": 2723.00,
  "payout_method_type": "bank_account",
  "metadata":
  {
    "bankCode": "AXABBE22",
    "bankName": "AXA Bank Europe",
    "bankBranch": "Bruxelles Trone",
    "bankAddress": "Place du Trone, 1, 1000, Bruxelles, Belgium",
    "bankZipcode": "12345",
    "bankRoutingNumber": "123456789",
    "bankAccountNumber": "12345678901234567890",
    "bankAccountName": "Current account",
    "phone": "+18419998877",
    "customerFirstName": "John",
    "customerLastName": "Smith",
    "email": "[email protected]"
  }
}
Request example (credit card)
Request
Response
POST /{{version}}/{{API_KEY}}/payouts
Content-Type: application/json
Host: {{API_URL}}
Authorization: Bearer {{ACCESS_TOKEN}}
{
  "order_id": "a17331a5",
  "provider": "PspName",
  "country": "BE",
  "currency": "EUR",
  "state": null,
  "amount": 1440.00,
  "payout_method_type": "credit_card",
  "metadata":
  {
    "creditCardToken": "",
    "creditCardNumber": "4012888888881881",
    "cardHolderName": "John Smith",
    "expiryMonth": 1,
    "expiryYear": 2022,
    "customerFirstName": "John",
    "customerLastName": "Smith",
    "email": "[email protected]"
  }
}
{
  "response": {
    "status": "OK",
    "code": 200,
    "message": "OK"
  },
  "result": {
    "payout_method": "credit_card",
    "html": null,
    "is_decoded": false,
    "email_instruction_enabled": null,
    "open_in_new_window": false,
    "id": "40877f24",
    "transaction_id": "85f9daa5",
    "amount": 1440.00,
    "processing_date": "2020-08-20 05:44:49",
    "failure_code": null,
    "status": "Approved",
    "currency": "EUR",
    "payment_method": "credit_card"
  }
}
post
<URL>
/{{version}}/{{API_KEY}}/payout
Create Payout

Payouts - Previous

Get payout providers

Next - Payouts

Get payout by ID

Last modified 4mo ago

Copy link

Outline

Request example (bank account)

Request example (credit card)

post

Create Payout