Skip to main content

Apolopag

Introduction

Apolopag is a service that allows you to make payments by card or through the alternative payment methods PIX and PicPay. It also allows PIX Payouts. It can be used both at Paylands checkout and through redirection, as well as with push payments.

Extra data required

Apolopag expects to receive the following information in the extra_data field when creating the order, for card payments or for PUSH payments with PIX and PicPay:

  • Name and surname
  • Email address
  • Document identification number (CPF)
  • Phone number
  • Birthdate (optional if payment card)

These fields can be provided with the following structure in extra_data:

"extra_data": {
"profile": {
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@paynopain.com"
"document_identification_number": "659.516.937-13",
"birthdate": "1996-01-01",
"phone": {
"number": "5151428089"
}
}
}

Payouts

To use PIX Payouts with Apolopag it is necessary to send the following information in the extra_data:

  • Name and surname
  • Identification document (CPF)
  • Phone
  • Bank code
  • Bank agency number
  • Account number
  • Account type (current/saving/salary/payment)
"extra_data": {
"profile": {
"first_name": "John",
"last_name": "Doe",
"document_identification_number": "842.359.516-10"
},
"payment": {
"bank_code": "218",
"branch": "0944",
"account": "091234-5",
"account_type": "current"
}
}

Payment methods in Sandbox

Test card is as follows. In general, the expiration date and CVV do not matter as long as the date is after the current date, and the CVV has 3 digits.

- card number: 4111 1111 1111 1111 1111
- expiration date: 12/34
- cvv: 123

Currency

The supported currency for this service is Brazilian real (BRL).

Error Codes

Error codes in Apolopag follow the following structure:

Code - Message

For example:

400 - first and last name are required