Recurring Pix

How to use Recurring Pix to submit a payin in Brazil.

Payin by Recurring Pix

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

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

Headers

Name
Type
Description

Content-Type*

string

application/json; chartset=UTF-8

Authorization*

string

Basic Base($app_id:$security_key)

Request Body

Name
Type
Description

app_id*

string

created app's id at dashboard

- Max. 32 chars -

method*

string

Fixed value: PIX

out_trade_no*

string

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

notify_url*

string

Where Pagsmile will send notification to

timestamp*

string

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

subject*

string

payment reason or item title

- Max. 128 chars -

content

string

payment reason detail or item detail.

- Max. 255 chars -

order_amount*

string

payment amount - 0.1~50,000 BRL -

order_currency*

string

Fixed value: BRL

trade_type*

string

Fixed value: API

buyer_id*

string

merchant user's id

interval*

string

W(week), M(month, only support 1M, 3M & 6M), Y(year) - Default value: 1M -

quantity*

string

Quantity of recurring - No maximum limit. Default value: 0, means infinite quantity -

timeout_express*

string

m(minutes), h(hours), d(days), c(always end in current day).

Used to control the expiration time of submitting an order (90m in default, max 15d)

customer.name*

string

User's name

customer.identify.type*

string

User's identification type

- CPF or CNPJ -

customer.identify.number*

string

User's identification number

- 11 digits if CPF or 14 digits if CNPJ -

  • Cancel Recurring PIX: Use this API to cancel a recurring PIX order.

  • IPN Notification/Callback: The callback of a recurring PIX payment is different from the callback of a regular PIX payment. Check the Recurring Notification page.

Example of API Request

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.

Third-party CPF/CNPJ Validator

PreviousPixNextPIX Biometria

Last updated

Was this helpful?