Checkout Page
How to request a checkout page.
This endpoint allows you to request a checkout page.
POST
https://sandbox.transfersmile.com /api/checkout
Headers
Content-Type*
String
application/json; charset=UTF-8
Authorization*
String
SHA256($sorted_params + $app_key)
AppId*
String
Your App ID in payout platform
Request Body
user_id*
String
user id
custom_code*
String
merchant payout id
fee_bear*
String
one of [beneficiary | merchant]
source_currency*
String
Merchant Account Currency
- One of: USD, EUR, GBP, BRL -
payout_currency*
String
Payout/Arrival Currency
- One of: USD, BRL, MXN -
payout_amount*
String
Payout Amount, Numeric
timeout
Integer
default & max 1800 seconds
notify_url*
String
Where pagsmile will send notification to.
return_url*
String
When a user completes the payout, where will return back to.
additional_remark*
String
transaction description
- Length must less than 40 -
country
String
BRA for Brazil
MEX for Mexico
GLOBAL for PayPal
method
String
Payment Method
- e.g. PIX, SPEI, PayPal,BANKTRANSFER -
{
"code": 200,
"msg": "success",
"time": 1639473556,
"data": {
"checkout_url": "https://sandbox-payout.pagsmile.com/?t=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMTAwMDEiLCJwYXlvdXRfaWQiOiJUUzIwMjExMjE0MDkxOTE2NHExNE4yVUhCVTVYQiIsImN1c3RvbV9jb2RlIjoiY2hlY2tvdXRfdGVzdF8xMDAwMDQiLCJmZWVfYmVhciI6Im1lcmNoYW50Iiwic291cmNlX2N1cnJlbmN5IjoiVVNEIiwicGF5b3V0X2N1cnJlbmN5IjoiVVNEIiwicGF5b3V0X2Ftb3VudCI6IjEwLjAxIiwibm90aWZ5X3VybCI6Imh0dHBzOi8vc2FuZGJveC50cmFuc2ZlcnNtaWxlLmNvbS9hcGkvbm90aWZ5L2RlbW8iLCJyZXR1cm5fdXJsIjoiaHR0cHM6Ly93d3cuYmFpZHUuY29tIiwiYWRkaXRpb25hbF9yZW1hcmsiOiJjaGVja291dCB0ZXN0IiwiY291bnRyeSI6IkJSQSIsInNlc3Npb25fdGltZW91dCI6MTgwMCwiY3JlYXRlZF9hdCI6MTYzOTQ3MzU1NiwiaXNzIjoiUGFnc21pbGUgLSBUcmFuc2ZlcnNtaWxlIiwiZXhwIjoxNjM5NDc1MzU2LCJqdGkiOiIzMiJ9.6Bmm2jrJUtlfWy9FrxPagsmilePayouttIwbhUx-OoCdU2aZMw"
}
}
Request Example
curl --location --request POST 'https://sandbox.transfersmile.com/api/checkout' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
"user_id": "10001",
"custom_code": "my_checkout_test_10001",
"source_currency": "USD",
"payout_currency": "BRL",
"fee_bear": "merchant",
"payout_amount": "10.01",
"notify_url": "https://sandbox.transfersmile.com/api/notify/demo",
"return_url": "https://merchant.return.url",
"additional_remark": "pagsmile checkout test",
"country": "BRA"
}'
Checkout Logo
WEB
128px * 64px
H5
42px * 42px
Supported Countries
BRA(Brazil)
PIX, Banktransfer
USD, BRL
BRL
MEX(Mexico)
SPEI
USD, MXN
MXN
GLOBAL
PayPal
USD
USD
Last updated
Was this helpful?