Crypto Payouts

Here you will find a description of the flow to send payouts using our new crypto channel

PayRetailers now allows Merchants to send payouts via cryptocurrency. The flow is a little different from our other payout soluitions, so here you will find an explanation to get started.

Here is a step by step guide to the new flow:

  • The first difference is that in the request you will need to send us the value "payoutChannel": "CRYPTO"
  • You will also need to send the new parameter DoB that is nested in the new Customer object. As a result, the request for a crypto payout will look like this:
{
    "Amount": 12000,
    "BeneficiaryFirstName": "John",
    "BeneficiaryLastName": "Doe",
    "DocumentType": "1",
    "DocumentNumber": "1234567",
    "Email": "[email protected]",
    "Phone": "1234567890",
    "CurrencyCode": "ARS",
    "Country": "AR",
    "BankName": "-",
    "AccountNumber": "-",
    "PayoutAccountTypeCode": "-",
    "ExternalReference": "Test BVNK 09"
    “PayoutChannel”: “CRYPTO”,
    “Customer”:{
	“DoB” : “1986-06-25”
    }
}
  • After sending these new parameters, the response will look the same as a regular payout response, with just the Payout Id to let you know the payout was created successfully.
  • The next step will be to use the external reference you provided in the request to call the Get Payout Details endpoint to obtain the full details of the payout. Here you will find a new parameter "checkoutUrl" with the url where you will need to redirect the customer to provide their wallet address. The payout details for a Crypto Payout will look like this:
{
    "payoutId": 46635982,
    "payoutBatchId": 0,
    "payoutBeneficiaryTypeCode": null,
    "beneficiaryFirstName": "John",
    "beneficiaryLastName": "Doe",
    "documentType": "1",
    "documentNumber": "1234567",
    "email": "[email protected]",
    "currencyCode": "ARS",
    "country": "AR",
    "bankName": "-",
    "accountAgencyNumber": null,
    "accountNumber": "-",
    "abaSwift": null,
    "amount": 12000,
    "address": null,
    "city": null,
    "gender": null,
    "paymentReason": null,
    "errorReason": null,
    "statusTypeCode": "PENDING",
    "payoutAccountTypeCode": "-",
    "externalReference": "Test BVNK 11",
    "notificationUrl": null,
    "phone": "1234567890",
    "testMode": null,
    "termsApproved": null,
    "testModeCallBackStatus": null,
    "recipientPixKey": null,
    "payoutChannel": "CRYPTO",
    "aliasCVU": null,
    "settlementAmount": 9.493295360151892725762430284,
    "customer": null,
    "paymentMethodDetails": {
        "statusModifier": "",
        "waitingCustomerAction": true,
        "digitalWalletAddress": ""
    },
    "checkoutUrl": "https://public.payretailers.com/bvnk/payouts/api/public/QyTlj6uJK3qwYW1NZ_Tpfg"
}
  • Once the customer has completed the required information and received the payout, you will get a webhook notification of the finished payout the same way as for all other payouts

Check the Create Payout of our API reference for more details on the creation of Payouts.