PIX (Brazil)
This payment solution is only available in Brazil
Last updated
This payment solution is only available in Brazil
Last updated
POST https://api.stage.localpayment.com/api/payin
Post a Pix order
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
To create a Pix payment order through LP api, the request body examples are detailed below.
To review how the PIX payments work please go to this link.
A Pix Bank Transfer payment order expires by default within 7 days iafter the creation date.
However, the expiration date can be set according to our clients requirements between 1 to 7 days.
Pix's payment order response will return, among others, an OBJECT named "qr". The elements that compose the "qr" object are: "image", code", "codeBase64" and "expirationDate".
To generate a Pix payment ticket, please select the "image" element. Clicking on that element will redirect you to a QR code. This QR code contains the information related to the previously created Pix payment. The QR code on the ticket should be scanned with your mobile phone to make the payment. Once the payment is made, the funds will be credited to the account immediately.
This payment solution is only available in Brazil .
The funds will be credited to the account only after the customer scans the QR code on their phone and completes the payment.
Authorization*
string
Mandatory. JWT token in format Bearer eyJ0... . For more information about authentication, please refer to Authentication
paymentMethod*
OBJECT
Mandatory. Payment method details
paymentMethod.type*
string
Mandatory. BankTransfer
paymentMethod.code*
string
Mandatory. Select among the codes available in each country for a payin BankTransfer payment type. NOTE: payment method code might affect the collection currency in bimonetary countries. For more info, see the side note on currency field.
paymentMethod.flow*
string
Mandatory. The payment method data could be embeded in the API request (DIRECT)or collected via an aditional form or plugin (REDIRECT). Currently, only DIRECT flow is allowed.
externalId*
string
Mandatory. An ID that is meaningful to you and your system. It must be unique and alphanumeric, no characters allowed.
country*
string
Mandatory. "BRA": Brazil in ISOCode3 format
amount*
number
Mandatory. Amount to charge to your end user. For BRL, use 2 decimal places separated by a dot.
currency*
string
Mandatory. The currency in which the amount is expressed. It could be A) the local currency of the selected country or B) the account's currency. If A), the amount will be charged to the customer's cash payment method. If B) and it differs from the local currency, the amount specified will be credited to your account and Localpayment will perform a Foreign Exchange operation to collect the amount expressed in local currency. In bimonetary countries, paymentMethod.code resolves possible ambiguity: the payment will be executed in the currency of that specific payment method network. e.i.: SPID (USD); SPEI (MXN)
accountNumber*
string
Mandatory. Your Localpayment account number in which the amount will be credited.
conceptCode
string
Mandatory. Choose the suitable concept code from our Concept Code List. Based on our experience, the most usual are 0039 (remittances) and 0040 (corporate payments).
comment
string
Optional. A comment related to the transaction. It should be something meaningful to your business.
exchangeRateToken
string
Optional. Token provided by the Foreign Exchange service in order to use an upfront agreed exchange rate.
payer*
OBJECT
Mandatory. Party Object. Information related to the payer.
type*
string
Mandatory. Possible values: COMPANY, INDIVIDUAL
name*
string
Mandatory. Individual first name / company name. The minimum value is two digits
lastName
string
Mandatory for individuals / Ignored for companies. The minimum value is two digits.
document*
OBJECT
Mandatory.Party Object. Valid identity document.
document.type*
string
Mandatory. Document types: CPF / CNPJ
document.id*
string
Mandatory. Identity document Id. Usually numbers or combination of numbers and letters.
userReference
string
Optional. Username or id in your platform.
string
Optional.
phone
OBJECT
Optional. Party Object. Contact phone number
phone.countryCode
string
Optional.
phone.areaCode
string
Optional
phone.number
string
Optional
birthdate
string
Optional. Individual birthdate / company incorporation date. ISO 8601 format (YYYY-MM-DD)
nationality
string
Optional
address
OBJECT
Optional. Party Object. Contact address
address.street
string
Optional
address.number
string
Optional
address.city
string
Optional
address.state
string
Optional
address.country
string
Optional
address.zipCode
string
Optional. Zip code / Postal code
address.comment
string
Optional. Additional info, such as floor or apartment number.
intermediaries
array
Optional. Array of Party objects. It represents others parties in the payment chain because of the end user is not your direct customer. Take into account the array sequence: your client should be the first element, the client of your client should be the second and so on, until there are no more intermediaries.
device
OBJECT
Optional.
device.id
string
Optional. Android / iPhone device ID. Can be blank for other device types such as PC / Mac.
device.ip
string
Optional. Device IP address
device.browser
string
Optional. Browser
metaData
OBJECT
Optional. Unstructured object to record any metadata meaningful to you.
commercialData
OBJECT
Optional. Party Object. Extra information related to the goods or services traded.
lastName
string
Mandatory only for INDIVIDUAL type / Ignored for COMPANY.
name*
string
Mandatory. Individual first name / company name
merchant*
OBJECT
Mandatory. Party Object.
type*
string
Mandatory. Possible values: COMPANY, INDIVIDUAL
document.type*
string
Optional. Document type (related to the merchant's residence)
phone.countryCode
string
Optional.
phone
OBJECT
Optional. Party Object. Contact phone number
email*
string
Optional.
userReference
string
Optional. Username or id in your platform.
document.id*
string
Optional. Identity document id. Usually numbers or combination of numbers and letters.
document*
OBJECT
Optional. Party Object.
address
OBJECT
Optional. Party Object. Contact address
nationality
string
Optional.
birthdate
string
Optional. Individual birthdate / company incorporation date. ISO 8601 format (YYYY-MM-DD).
phone.number
string
Optional.
phone.areaCode
string
Optional.
address.comment
string
Optional. Additional info, such as floor or apartment number.
address.city
string
Optional.
address.number
string
Optional.
address.street
string
Optional.
address.zipCode
string
Optional. Zip code / Postal code
address.country
string
Optional.
address.state
string
Optional.
bank
OBJECT
Optional. Party Object. Payer account data.
bank.name
string
Optional. Bank name.
bank.branch.code
string
Optional. . Brach code.
bank.branch
OBJECT
Mandatory only if Bank Object was added. Branch information. Party Object.
bank.code
string
bank.account
OBJECT
Optional. Party Object. Payer account information.
bank.branch.name
string
Optional. . Branch name.
bank.account.type
string
bank.account.number
string
Optional. Payer account number
item.id
string
Optional. Item ID
invoice
string
Optional. Invoice reference
item
array
Optional. List of sold items
items.quantity
number
Optional. Item quantity
items.categoryId
string
Optional. Item category
items.pictureUrl
string
Optional. URL pointing to an item picture
items.description
string
Optional. Item description
item.title
string
Optional. Item title
items.unitPrice
number
Optional. Unit price
shipments.city
string
Optional. City
shipments.number
String
Optional. Number address
shipments.street
string
Optional. Street address
shipments
array
Optional. List of shipping addresses
shipments.country
string
Optional. State/Province
shipments.state
string
Optional. State/ProvinceShipping country
shipments.comment
string
Optional. Additional info
shipments.zipCode
string
Optional. Zip code
name
string
Optional. Individual / Company name
type
string
Optional. Possible values: COMPANY, INDIVIDUAL
beneficiary
OBJECT
Optional. Party Object
lastName
string
Optional only for INDIVIDUAL type / Ignored for COMPANY.
document.id
string
Optional. Identity document id. Usually numbers or combination of numbers and letters
document.type
string
Optional. Document type (related to the beneficiary's residence)
document
OBJECT
Optional. Party Object.
string
Optional.
