PayRetailers

Info

Confirm the supported currencies and countries with your manager.

This alternative payment method supports the following operations:

---

Payment

Request

Send a payment request with the following data in the method section:

Parameter	Type	Description
method	object	A section of the payment method information.
type * required	string	pay_retailers
channel * required	string	The ID of the payment method for Pay Retailers.
customer	object	A section of the customer details.
first_name	string	The customer's first name.
last_name	string	The customer's last name.
country	string	The customer's country.
email	string	The customer's email address. Required for Brazil, Mexico, Colombia and Argentina.
city	string	The customer's city. Required for Brazil.
phone	string	The customer's phone number. Required for Brazil.
address	string	The customer's address. Required for Brazil.
id_number	string	The customer's national ID. Required for Brazil, Chile and Colombia.

Info

You can get the full list of payment methods by https://api.gateway.payretailers.com/v2/paymentMethods

Response

The pay_retailers response section will have the parameters copied from the request, as well as the form section with parameters to build a form. You should redirect the customer to the form to finalize the payment.

---

Payout

Request

Send a payout request with the following additional data:

Parameter	Type	Description
method	object	A section of the payment method information.
type * required	string	pay_retailers
bank_name * required	string	The customer's bank name.
account * required	string	The customer's account number.
account_name * required	string	The customer's payout account type code.
bank_branch_code * required	string	The customer's account agency number. Required for Brazil.
customer	object	A section of the customer details.
first_name * required	string	The customer's first name.
last_name * required	string	The customer's last name.
country * required	string	The customer's country.
id_number * required	string	The customer's document number.
email * conditionally required	string	The customer's email address. Required for Brazil.
phone * conditionally required	string	The customer's phone number. Required for Brazil.
additional_data	object	A section of additional data.
customer	object	A section of additional data about the customer.
type * conditionally required	string	The customer's payout beneficiary type code. Possible value: person; company. Required for Chile.
id_type * conditionally required	string	The customer's document type.

Response

The pay_retailers response section will have the parameters copied from the request.