Create payout

Create payout

POST <HOST_URL>/api/payout

redirect_url field is relevant only for cardp2p method

Headers

Name	Type	Description
credentials*	String

Request Body

Name	Type	Description
order_id*	String	ID of transactions in your system
amount*	Number	Operation amount
currency*	String	Currency of operation
payment_method	String	Default value: card. Possible values: card, imps, openbanking, sbp
customer_first_name*	String	Customer`s first name
customer_last_name*	String	Customer`s last name
customer_phone	String	Customer`s phone number
customer_email	String	Customer`s email
webhook_url	String (URL)	URL to which webhook will be sent
card_number	String	Required if "payment_method" is "card"
wallet_number	String	Required if "payment_method" is "qiwi"
imps_account	String	Required if "payment_method" is "imps"
ifsc_code	String	Required if "payment_method" is "imps"
cpf	String	Required if payment_method is "pix"
iban	String	Required if payment_method is "openbanking"
redirect_success_url	String (URL)	URL to which user will be redirect after successful payout (only for cardp2p method)
redirect_fail_url	String (URL)	URL to which user will be redirect after unsuccessful payout (only for cardp2p method)
pending_url	String (URL)	URL to which the user will be redirected if the payout has not received the final status (only for cardp2p method)
nspk_bank_code	String	Required if payment_method is "sbp"

200: OK

{
    "status": 1,
    "status_transaction": "processing",
    "order_id": "string",
    "amount": 22.22,
    "currency": "EUR",
    "description": "Payment processing",
    "payment_id": 1000
    "redirect_url": "https://api.cashbulls.io"
}

Sandbox values

You can use the following card numbers to simulate a specific payment scenario. If you transmit other values, the transaction will take an unsuccessful status.

Card number	State
5460550340000013	declined
4111111111111111	approved
5460550340000005	instant declined

IBAN	State
CY21002001950000357001234567	declined
GB33BUKB20201555555555	approved
UA903052992990004149123456789	instant declined

IMPS	State
0987654321	declined
1234567890	approved
1029384756	instant declined

Customer phone (sbp)	State
[phone]	declined
[phone]	approved
[phone]	instant declined