Create payin (legacy)
Creating a new payin
Create payin
POST {API_BASE_URL}/v1/merchants/payins/
Initiates a new payin (deposit transaction).
Headers
x-merchant-id*
string
x-timestamp*
number
x-signature*
string
Request Body
reference_id
string [1..64]
Your internal transaction id which you may use to find the transaction easier
payment.amount*
number
Amount of the transaction
payment.currency*
enum
customer.id*
string [1..64]
Id of the customer in your system. You may use customer's email or their phone number if you don't have or don't want to provide a different identifier
customer.email*
string [6..255]
Customer's email address
customer.first_name*
string [2..80]
Customer's first name
customer.last_name*
string [2..80]
Customer's last name
customer.date_of_birth*
date
Customer's date of birth in "yyyy-mm-dd" format
customer.phone.country_code*
string [2..4]
Country code of the customer's phone number, starting with "+"
customer.phone.number*
string [5..40]
Customer's phone number without the country code
customer.address.addr_line_1*
string [3..64]
Customer's street address
customer.address.addr_line_2
string [3..64]
Customer's address extra data
customer.address.city*
string [3..40]
Customer's city
customer.address.state
Customer's state. Required for Canada (enum)
customer.address.zip*
string [3..12]
Customer's postal code
customer.address.country*
enum
Customer's country code in the 2-letter format (ISO 3166-1 alpha-2)
browser_data.user_agent*
string
Customer's current user agent
browser_data.ip_address*
string
Customer's current IP address. If incorrect, the customer will not be able to see the transaction details
webhook_url*
string
redirect_urls.fail*
string (url)
Customer will be redirected to this link when a transaction fails or gets canceled
redirect_urls.success*
string (url)
Customer will be redirected to this link after successfully completing a transaction
language
enum
Example
Last updated