PayPal

Cómo usar PayPal para enviar un payout.

Submit a payout by PayPal globally.

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

Este endpoint te permite usar Paypal para realizar un payout globalmente.

Headers

Name	Type	Description
Content-Type*	string	application/json; chartset=UTF-8
AppId*	String	Su app ID en la plataforma de payout
Authorization*	String	SHA256($sorted_params + $app_key)

Request Body

Name	Type	Description
name	String	Nombre de beneficiario - Min.5 Max.100 -
phone	String	Teléfono de beneficiario.
email	String	Correo de beneficiario
account*	String	Cuenta de PayPal.
account_type*	String	Fijo: EMAIL
custom_code*	String	ID de orden de merchant
channel*	String	Fijo: PayPal
method*	String	Fijo: WALLET
document_type	String	Tipo de identificador del beneficiario
document_id	String	Número de identificación de beneficiario
source_currency*	String	Moneda de cuenta de merchant - soporta: USD, GBP, EUR -
fee_bear*	String	Sólo uno [beneficiario | merchant]
amount*	String	Monto de Payout, 2 números decimales - Min 0.01, Max 50,000 -
arrival_currency*	String	Moneda de cuenta de beneficiario. @see supported currencies
notify_url*	String	Donde Pagsmile enviará el callback
additional_remark*	String	Payout nota - Max long: 40 -
country*	String	País de beneficiario. @See supported countries
amount_type	String	Especificar si valor de monto es fijo para merchant o beneficiario - Sólo uno: source_amount, arrival_amount(default) -

200: OK Envio exitoso

{
    "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 Desautorizado

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

500: Internal Server Error Error de servidor

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

400: Bad Request Orden ya existe

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

500: Internal Server Error Balance insuficiente

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

500: Internal Server Error Tarifa no configurada

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

Ejemplo

curl --location --request POST 'http://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******[e-mail]",
    * "account" : "[e-mail]",
    * "account_type" : "EMAIL",
      "document_id" : "CUP800****691",
      "document_type" : "RFC",
    * "method" : "WALLET",
    * "channel" : "PayPal",
    * "custom_code" : "custom_code9982674851738108",
    * "fee_bear" : "merchant",
    * "amount" : "0.51",
    * "source_currency" : "USD",
    * "arrival_currency" : "USD",
    * "notify_url" : "https://notify.url",
    * "additional_remark" : "pagsmile payout test",
    * "country": "BRA"
}'

Nota: 94FAC**********************68548 es el test ID de pagsmile para prueba en sandbox, y d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302 es el token de autorización asociado con el app ID de prueba.

En ambiente sandbox, favor usar [e-mail] como cuenta de Paypal para realizar pruebas exitosas, cualquier otra cuenta de Paypal fallará.