📄
API Documentation
  • Introduction
    • Authorization
    • Webhooks
    • Statuses
  • API Methods
    • Create payment
    • Create payout
    • Check status
    • Get balance
Powered by GitBook
On this page
  • Create payment (host to host)
  • Create payment (payment page)
  • Sandbox values
  1. API Methods

Create payment

Create payment (host to host)

POST <HOST_URL>/api/payment/create

Headers

Name
Type
Description

credentials*

String

Request Body

Name
Type
Description

order_id*

String

ID of transactions in your system

currency*

String

Currency of operation

amount*

Number

Operation amount

payment_method

String

Default value: card. Possible values: card, upi, cardp2p, openbanking, sbp, sberpay, blik_code, one_click_pay, iban, skrill, neteller

customer_ip*

String

Customer`s IP address

customer_first_name

String

Customer`s first name. Required for "card", "upi", "openbanking", "blik_code", "skrill", "neteller" payment_method

customer_last_name

String

Customer`s last name. Required for "card", "upi", "openbanking", "blik_code", "skrill", "neteller" payment_method

customer_phone

String

Customer`s phone. Required for "card", "upi", "openbanking", "blik_code", "skrill", "neteller" payment_method

customer_country

String

Customer`s country code in ISO 3166-1 alpha-2 format. Required for "card", "openbanking", "skrill", "neteller" payment_method

customer_city

String

Customer`s city. Required for "card", "openbanking", "blik_code" payment_method

customer_state

String

Customer`s state. Required for "card", "openbanking", "blik_code" payment_method

customer_address

String

Customer`s address. Required for "card", "openbanking", "blik_code" payment_method

customer_zip_code

String

Customer`s zip code. Required for "card", "openbanking", "blik_code" payment_method

customer_email*

String

Customer`s email

redirect_success_url*

String (URL)

URL to which user will be redirect after successful payment

redirect_fail_url*

String (URL)

URL to which user will be redirect after unsuccessful payment

pending_url*

String (URL)

URL to which the user will be redirected if the payment has not received the final status

webhook_url

String (URL)

URL to which webhook will be sent

card_number

String

Customer`s card number. Required for "card" payment_method

card_exp_month

Number

Card expiration month. Required for "card" payment_method

card_exp_year

Number

Card expiration year. Required for "card" payment_method

card_cvv

String or Number

Card CVV. Required for "card" payment_method

upi_account

String

Required for "upi" payment_method

cpf

String

Required if payment_method is "pix"

safetyPay_channel

String

Required if payment_method is "SafetyPay"

card_holder

String

Cardholder. Required for "card" payment_method

iban

String

Required if payment_method is "iban"

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

Create payment (payment page)

POST <HOST_URL>/api/payment/createForm

Headers

Name
Type
Description

credentials*

String

Request Body

Name
Type
Description

amount*

Number

Operation amount

currency*

String

Currency of operation

order_id*

String

ID of transactions in your system

customer_ip*

String

Customer`s IP address

redirect_success_url*

String (URL)

URL to which user will be redirect after successful payment

redirect_fail_url*

String (URL)

URL to which user will be redirect after unsuccessful payment

pending_url*

String (URL)

URL to which the user will be redirected if the payment has not received the final status

webhook_url

String (URL)

URL to which webhook will be sent

payment_method

String

Default value: card. Possible values: card

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

Sandbox values

You can use the following card numbers to simulate a specific payment scenario. If you transmit other card numbers, the transaction will take an unsuccessful status. The expiry date and CVV can take any valid value.

Card number
State

5460550340000013

3ds

4111111111111111

approved

5460550340000005

declined

Last updated 3 hours ago