PIXParaguay

How to use PIXParaguay to submit a payout in Paraguay.

Post

https://api.luxtak.com/api/payout

Submit a payout by PIXParaguay in Paraguay

This endpoint allows you to submit a payout by PIXParaguay in Paraguay.

Parameters

ParameterTypeDescription
Content-Type*stringapplication/json; chartset=UTF-8
AppId*stringYour App ID in payout platform
Authorization*stringSHA256($sorted_params + $app_key)

Body

ParameterTypeDescription
amount*stringPayout Amount, 2 decimal numbers
- Min 0.01, Max 15,000 -
source_currency*stringMerchant Account Currency
- One of: USD, EUR, GBP, BRL -
arrival_currency*stringFixed value: BRL
fee_bear*stringProcessing fee charges to merchant or beneficiary.
- One of: merchant beneficiary -
phonestringBeneficiary's phone
- 0 ~ 15 digits -
name*stringBeneficiary's name
- Length between 5 and 100 -
document_type*stringBeneficiary's personal identification type
- One of: CPF, CNPJ -
document_id*stringBeneficiary's personal identification number
emailstringBeneficiary's email
account_type*stringBeneficiary's PIXParaguay account type
- One of: CPF, CNPJ, EVP, PHONE, EMAIL -
account*stringBeneficiary's PIXParaguay account
custom_code*stringMerchant Payout ID
- Max. 50 chars -
notify_url*stringWhere luxtak will send notification to.
method*stringFixed value: PIXPARAGUAY
additional_remark*stringDescriptor on the user's bank bill
- Max length: 40 -
country*stringPRY for Paraguay

Responses

StatusDescription
200: OKsubmit successfully
{
    "code":200,
    "msg":"success",
    "time":1775037261,
    "data"{
      "id":"LT20******PPY",
      "custom_code":"custom_code1318***cyr",
      "arrival_amount":"1",
      "arrival_currency":"BRL",
      "source_amount":"1.01",
      "source_currency":"BRL",
      "status":"IN_PROCESSING"
   }
}
StatusDescription
400: Bad Requestorder already existed
{
    "code": 4001010,
    "msg": "order already existed",
    "time": 1628580940,
    "data": {}
}
StatusDescription
401: Unauthorizedunauthorized
{
    "code": 4004003,
    "msg": "permission denied",
    "time": 1637224716,
    "data": {}
}
StatusDescription
500: Internal Server Errorfee not configured
{
    "code": 5001003,
    "msg": "fee not configured",
    "time": 1637224716,
    "data": {
        ... ...
    }
}
StatusDescription
500: Internal Server Errorbalance insufficient
// system error
{
    "code": 5001102,
    "msg": "balance insufficient",
    "time": 1637224716,
    "data": {
        ... ...
    }
}
StatusDescription
500: Internal Server Errorsystem error
{
    "code": 5001000,
    "msg": "system error",
    "time": 1637224716,
    "data": {}
}

Example

curl --location --request POST 'https://sandbox.luxtak.com/api/payout' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
    * "amount" : 1,
    * "source_currency" : "BRL",
    * "arrival_currency" : "BRL", // fixed value: BRL
    * "fee_bear" : "merchant",
    * "phone" : "+551*****19",
    * "name" : "Test",
    * "document_type" : "CPF", // should be one of CPF CNPJ PHONE EMAIL EVP
    * "document_id" : "390***26",
    * "email" : "[email protected]",
    * "account_type" : "EVP",
    * "account" : "2b5****a40",
    * "custom_code" : "custom_code13***ocyr",
    * "notify_url" : "https://www.test.com",
    * "method" : "PIXPARAGUAY", // fixed value: PIXParaguay
    * "additional_remark" : "testpayout0012345",
    * "country" : "PRY" // fixed value: PRY
}'

Tips

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

Tips

In sandbox environment, please use **[email protected]_** as PIXParaguay account , and EMAIL as account_type for testing REJECTED payout, any other PIXParaguay account will be success (PAID).

Example of Document

Document TypeDocument IDDescription
CPF22*******9911 digits
CNPJ23**********3114 digits

Third-party CPF/CNPJ Validator

Example of PIXParaguay account

Account TypeAccountDescription
CPF22*******9911 digits
CNPJ23**********3114 digits
Phone+5511987654321 or 11987654321country code (+55) is optional
Email[email protected]​
EVPA UUID-like string: a1073db4-a3a0-11ed-a8fc-0242ac120002alphanumeric string of 32 digits that is sent from the central bank to the institution