OpenFinance

How to use OpenFinance to submit a payin in Brazil.

Payin by OpenFinance

POST https://gateway-test.pagsmile.com/trade/pay

This endpoint allows you to submit a payin by OpenFinance in Brazil.

Headers

NameTypeDescription

Content-Type*

string

application/json; chartset=UTF-8

Authorization*

string

Basic Base($app_id:$security_key)

Request Body

NameTypeDescription

app_id*

string

created app's id at dashboard

- Max. 32 chars -

customer.phone

string

User's phone

customer.email*

string

User's email

customer.identify.number*

string

User's identification number

- 11 digits if CPF (CNPJ NOT support)-

method*

string

Fixed value: OpenFinance

out_trade_no*

string

ID given by the merchant in their system - Max. 64 chars -

notify_url*

string

Where Pagsmile will send notification to

customer.identify.type*

string

User's identification type

- CPF (CNPJ NOT support) -

customer.name*

string

User's name

timestamp*

string

yyyy-MM-dd HH:mm:ss - Max. 19 chars -

subject*

string

payment reason or item title

- Max. 128 chars -

order_amount*

string

payment amount - 0.1 ~ 20,000 BRL -

order_currency*

string

Fixed value: BRL

content*

string

payment reason detail or item detail. This will be shown on the bank bill.

- Max. 255 chars -

buyer_id*

string

merchant user's id

address.zip_code

string

zip code

website_url

string

merchant website URL

- Max. 128 chars -

address.street

string

street

address.street_number

string

street number

address.city

string

city

address.state

string

state

return_url

string

Redirect to Merchant's url when user finished checkout

bank*

string

Use API to get bank id

{
    "code": "10000",
    "msg": "Success",
    "trade_no": "2022021810560500094",
    "out_trade_no": "202201010354003",
    "web_url": "",
    "pay_url": "https://nuapp.nubank.com.br/open-banking/authorize?client_id=",
    "trade_status": "PROCESSING"
}

User payment tips

  • pay_url is the bank URL which can redirect users to the bank mobile app or bank web.

  • CNPJ is not supported.

Example

curl --location --request POST 'https://gateway-test.pagsmile.com/trade/pay' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    * "app_id": "162************38",
    * "out_trade_no": "202201010354003",
    * "method": "OpenFinance",
    * "bank": "75e2b9f4-4f60-4d07-916c-fde1163d43bc",
    * "order_amount": "12.01",
    * "order_currency": "BRL",
    * "subject": "trade pay test",
    * "content": "trade pay test conent",
    * "notify_url": "http://merchant/callback/success",
      "return_url": "https://www.merchant.com",
    * "buyer_id": "buyer_0101_0001",
    * "timestamp": "2022-01-01 03:54:01",
      "timeout_express":"1c",
    * "customer" : {
    *     "identify": {
    *         "type": "CPF",
    *         "number": "11032341882"
          },
    *     "name": "Test User Name",
    *     "email": "test@pagsmile.com"
      }
      }'

Note: 162************38 is pagsmile's test app id for sandbox, and MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ== is authorization token associated with the test app id.

Please use your own app_id and generate your own authorization token when testing.

PreviousPixNextLottery

Last updated