Create payout
This method is used to create a payout transaction.

Request example (bank account)

1
POST /v1/{{API_KEY}}/payouts
2
Content-Type: application/json
3
Host: {{API_URL}}
4
Authorization: Bearer {{ACCESS_TOKEN}}
5
{
6
"order_id": "a17331a4",
7
"provider": "PspName",
8
"country": "BE",
9
"currency": "EUR",
10
"state": null,
11
"amount": 2723.00,
12
"payout_method_type": "bank_account",
13
"metadata":
14
{
15
"bankCode": "AXABBE22",
16
"bankName": "AXA Bank Europe",
17
"bankBranch": "Bruxelles Trone",
18
"bankAddress": "Place du Trone, 1, 1000, Bruxelles, Belgium",
19
"bankZipcode": "12345",
20
"bankRoutingNumber": "123456789",
21
"bankAccountNumber": "12345678901234567890",
22
"bankAccountName": "Current account",
23
"phone": "+18419998877",
24
"customerFirstName": "John",
25
"customerLastName": "Smith",
26
"email": "[email protected]"
27
}
28
}
Copied!

Request example (credit card)

Request
Response
1
POST /v1/{{API_KEY}}/payouts
2
Content-Type: application/json
3
Host: {{API_URL}}
4
Authorization: Bearer {{ACCESS_TOKEN}}
5
{
6
"order_id": "a17331a5",
7
"provider": "PspName",
8
"country": "BE",
9
"currency": "EUR",
10
"state": null,
11
"amount": 1440.00,
12
"payout_method_type": "credit_card",
13
"metadata":
14
{
15
"creditCardToken": "",
16
"creditCardNumber": "4012888888881881",
17
"cardHolderName": "John Smith",
18
"expiryMonth": 1,
19
"expiryYear": 2022,
20
"customerFirstName": "John",
21
"customerLastName": "Smith",
22
"email": "[email protected]"
23
}
24
}
Copied!
1
{
2
"response": {
3
"status": "OK",
4
"code": 200,
5
"message": "OK"
6
},
7
"result": {
8
"payout_method": "credit_card",
9
"html": null,
10
"is_decoded": false,
11
"email_instruction_enabled": null,
12
"open_in_new_window": false,
13
"id": "40877f24",
14
"transaction_id": "85f9daa5",
15
"amount": 1440.00,
16
"processing_date": "2020-08-20 05:44:49",
17
"failure_code": null,
18
"status": "Approved",
19
"currency": "EUR",
20
"payment_method": "credit_card"
21
}
22
}
Copied!
post
<URL>
/v1/{{API_KEY}}/payout
Create Payout
Last modified 1d ago