PayRetailers

PayRetailers is a payment service provider that facilitates online payments for emerging markets, particularly in Latin America and Africa. This integration offers access to over 300 payment methods, including traditional options like credit cards and alternative methods such as bank transfers, QR codes, and digital wallets.

Supported Transaction Types

• Authorisation

• Capture

• Purchase

• Refund

• Withdrawal

Integrations Supported

Deposit

• Hosted Payment Page

• Direct Connect ( server-to-server)

Withdrawal

• Hosted Payment Page

• Direct Connect ( server-to-server)

Currencies & Countries Supported

Available Options Per Country

Required Attributes to process through PayRetailers

You must include the following JSON attributes to the payload.

*¹ This node has been provided as an example for a deposit with BankIdentifierCode which is Optional and if it is not passed it will default to Payment Method assigned by the Provider.

The allowed Payment Methods by the Provider can be retrieved by calling the Get Payments Methods call found at the following link. The value of the BankIdentifierCode will have to be one of the PaymentMethodIds representing the specific payment method.

Note: The PaymentMethodData in the Payout is Mandatory.

*² Please refer to the Reference Values in the Table Hereunder for the PayoutAccountTypeCode (Account Types Section), BankName (Available Banks Section) and DocumentType (Document Types Section)

PIX Payout - The RecipientPixKey needs to be added to the PaymentMethodData JSON structure made available in the example above  e.g. "RecipientPixKey": "00183562658"

Attribute Description

Deposit Extra Parameters

• FirstName

• LastName

• Email

• Country (mandatory)

• MobileNo

• Street

• City

• ZIPCode

• IPAddress

• BankIdentifierCode

• PersonalId

• DeviceId

Payout Extra Parameters

• FirstName (mandatory)

• LastName (mandatory)

• Email (mandatory)

• Country (mandatory)

• DocumentType (mandatory) Values are in table "Document Types" specific by Country

• DocumentNumber (mandatory) Client’s document number as per the document type specified in the Document Type tag.

• BankAccountType (mandatory) Value must be specific per country. In Tables "Account Types" find the Account Types available per country. (Use the column value)

• BeneficiaryAccountNumber (mandatory)

• BankName (mandatory)  The Values can be found in the table "Available Banks". Use value column to send in the tag.

• AccountAgencyNumber (mandatory) - Agency Code of the bank. This information will be provided by the bank and it specifies the agency number within the bank. For PIX payouts only: Only numbers BEFORE the dash must be entered (example: 1234-5 would only be 1234). For Banco Do Brazil only: Format for account agency number must be "XXXX-X"

• RecipientPixKey - When using PIX payouts, the parameter RecipientPixKey is required. This parameter will vary in value depending on the customer's PIX key, which can be one of the following: Phone Number / E-Mail / Random Key

Reference Values

Account Types

Available Banks

Document Types

Reference Payloads

Deposit

Refer to our API Reference Document here to create a Hosted Payment Page, use the below mandatory tags to process a deposit.

Below is a sample deposit request.

 {
  "TransactionType": "PURC",
  "Currency": "BRL",
  "Amount": "100",
  "OrderReference": "Order0121"
  "UniqueReference": "4b8da4f0-d3b4-44ae-8019-8c66905ffad7",
  "RedirectionURL": "https://yoururl.com/Redirect/",
  "CallBackURL": "https://yoururl.com/Listener",
  "FailRedirectionURL": "https://yoururl.com/Redirect/",
  "Language": "en",
  "Client": {
    "Email": "test@email.com",
    "ClientAccount": "CliAcc01002",
    "FirstName": "John",
    "LastName": "Doe",
    "Country": "BRA",
    "MobileNo": "11960102030",
    "Street": "Street Name, 1",
    "City": "Rio De Janeiro",
    "ZIPCode": "30342",
    "State": "Brasil",
    "DateOfBirth": "1977-12-31",
    "IPAddress": "127.0.0.1"
  },
   "Routing": {
    "ForcePayment": "PAYRETAILERS"
  },
  "IsTest": true
}

Below is a sample deposit request with BankCode.

 {
  "TransactionType": "PURC",
  "Currency": "BRL",
  "Amount": "100",
  "OrderReference": "Order0121"
  "UniqueReference": "4b8da4f0-d3b4-44ae-8019-8c66905ffad7",
  "RedirectionURL": "https://yoururl.com/Redirect/",
  "CallBackURL": "https://yoururl.com/Listener",
  "FailRedirectionURL": "https://yoururl.com/Redirect/",
  "Language": "en",
  "Client": {
    "Email": "test@email.com",
    "ClientAccount": "CliAcc01002",
    "FirstName": "John",
    "LastName": "Doe",
    "Country": "BRA",
    "MobileNo": "11960102030",
    "Street": "Street Name, 1",
    "City": "Rio De Janeiro",
    "ZIPCode": "30342",
    "State": "Brasil",
    "DateOfBirth": "1977-12-31",
    "IPAddress": "127.0.0.1"
  },
   "Routing": {
    "ForcePayment": "PAYRETAILERS"
  },
  "PaymentMethodData" : {
    "BankIdentifierCode": "269ce926-07f3-4860-abc0-e4287758fb78"
  },
  "IsTest": true
}

Withdrawals

Withdrawals are processed via Direct Connect. The API reference to request a payout can be found here.

Below is a sample Withdrawal request.

{
  "TransactionType": "ORIGINALCREDIT",
  "Currency": "BRL",
  "Amount": "50",
  "OrderReference": "Order002"
  "UniqueReference": "4b8da4f0-d3b4-44ae-8019-8c66905ffad7",
  "RedirectionURL": "https://yoururl.com/Redirect/",
  "CallBackURL": "https://yoururl.com/Listener",
  "FailRedirectionURL": "https://yoururl.com/Redirect/",
  "Language": "en",
  "Client": {
    "Email": "test@email.com",
    "ClientAccount": "CliAcc01002",
    "FirstName": "John",
    "LastName": "Doe",
    "Country": "BRA",
    "MobileNo": "11960102030",
    "Street": "Street Name, 1",
    "City": "Rio De Janeiro",
    "ZIPCode": "30342",
    "State": "Brasil",
    "DateOfBirth": "1977-12-31",
    "IPAddress": "127.0.0.1"
  },
  "Routing": {
    "ForcePayment": "PAYRETAILERS"
  },
  "PaymentDestination": {
    "PaymentMethodData": {
      "PayoutAccountTypeCode": "0001",
      "BankName": "341",
      "DocumentNumber": "00183562658",
      "DocumentType": "1",
      "AccountAgencyNumber": "8585",
      "BankAccountType": "0001",
      "BeneficiaryAccountNumber": "0001"
    }
  },
  "IsTest": true
}

Below is a sample Withdrawal request for PIX Payout

{
  "TransactionType": "ORIGINALCREDIT",
  "Currency": "BRL",
  "Amount": "50",
  "OrderReference": "Order002"
  "UniqueReference": "4b8da4f0-d3b4-44ae-8019-8c66905ffad7",
  "RedirectionURL": "https://yoururl.com/Redirect/",
  "CallBackURL": "https://yoururl.com/Listener",
  "FailRedirectionURL": "https://yoururl.com/Redirect/",
  "Language": "en",
  "Client": {
    "Email": "test@email.com",
    "ClientAccount": "CliAcc01002",
    "FirstName": "John",
    "LastName": "Doe",
    "Country": "BRA",
    "MobileNo": "11960102030",
    "Street": "Street Name, 1",
    "City": "Rio De Janeiro",
    "ZIPCode": "30342",
    "State": "Brasil",
    "DateOfBirth": "1977-12-31",
    "IPAddress": "127.0.0.1"
  },
  "Routing": {
    "ForcePayment": "PAYRETAILERS"
  },
  "PaymentDestination": {
    "PaymentMethodData": {
      "PayoutAccountTypeCode": "0001",
      "BankName": "341",
      "DocumentNumber": "00183562658",
      "DocumentType": "1",
      "AccountAgencyNumber": "8585",
      "BankAccountType": "0001",
      "BeneficiaryAccountNumber": "0001",
      "RecipientPixKey": "00183562658"
    }
  },
  "IsTest": true
}