PayPal

How to use PayPal to submit a payout.

Submit a payout by PayPal globally.

POST https://sandbox.transfersmile.com/api/payout

This endpoint allows you to submit a payout by PayPal globally.

Headers

Name	Type	Description
Content-Type*	string	application/json; chartset=UTF-8
AppId*	String	Your App ID in payout platform
Authorization*	String	SHA256($sorted_params + $app_key)

Request Body

Name	Type	Description
name	String	Beneficiary's name - Min.5 Max.100 -
phone	String	Beneficiary's phone.
email	String	Beneficiary's email
account*	String	PayPal account.
account_type*	String	Fixed: EMAIL
custom_code*	String	Merchant's order id
channel*	String	Fixed: PayPal
method*	String	Fixed: WALLET
document_type	String	Beneficiary document type
document_id	String	Beneficiary document id
source_currency*	String	Merchant's account currency - supported: USD, GBP, EUR -
fee_bear*	String	One of [beneficiary | merchant]
amount*	String	Payout Amount, 2 decimal numbers - Min 0.01, Max 50,000 -
arrival_currency*	String	Beneficiary's account currency. @See supported currencies
notify_url*	String	Where pagsmile will callback to
additional_remark*	String	Payout Remark - Max length: 40 -
country*	String	Beneficiary's Country/Region code. @See supported countries
amount_type	String	Specify the amount value is fixed for merchant or beneficiary - One of: source_amount, arrival_amount(default) -

200: OK submit successfully

{
    "code": 200,
    "msg": "success",
    "time": 1628580845,
    "data": {
        "id": "TS202108100734054iRiUZFPXfQPB",
        "custom_code": "custom_code9982674851738108",
        "arrival_amount": "0.51",
        "arrival_currency": "BRL",
        "source_amount": "0.07",
        "source_currency": "USD",
        "status": "IN_PROCESSING"
    }
}

401: Unauthorized unauthorized

{
    "code": 4004003,
    "msg": "permission denied",
    "time": 1637224716,
    "data": {}
}

400: Bad Request order already existed

{
    "code": 4001020,
    "msg": "order already existed",
    "time": 1628580940,
    "data": {
        ... ...
    }
}

500: Internal Server Error server error

{
    "code": 5001000,
    "msg": "system error",
    "time": 1637224716,
    "data": {}
}

500: Internal Server Error balance insufficient

{
 // balance insufficient
{
    "code": 5001102,
    "msg": "balance insufficient",
    "time": 1637224716,
    "data": {
        ... ...
    }
}

500: Internal Server Error fee not configured

{
    "code": 5001003,
    "msg": "fee not configured",
    "time": 1637224716,
    "data": {
        ... ...
    }
}

Example

curl --location --request POST 'https://sandbox.transfersmile.com/api/payout' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
      "name" : "GUILHERME ****** SOUZA",
      "phone" : "468****068",
      "email" : "g******[email protected]",
    * "account" : "[email protected]",
    * "account_type" : "EMAIL",
      "document_id" : "**********",
      "document_type" : "***",
    * "method" : "WALLET",
    * "channel" : "PayPal",
    * "custom_code" : "custom_code_your_order_id",
    * "fee_bear" : "merchant",
    * "amount" : "0.51",
    * "source_currency" : "USD",
    * "arrival_currency" : "USD",
    * "notify_url" : "https://your.notify.url",
    * "additional_remark" : "pagsmile payout test",
    * "country": "USA"
}'

Note: 94FAC**********************68548 is Pagsmile's test App ID for sandbox, and d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302 is authorization token associated with the test App ID.

In sandbox environment, please use [email protected] as PayPal account for testing success payout, any other PayPal account will be failed.