RecurrenceCreate recurrence

Create recurrence

POST/v1/recurrencyhttps://api.securitypag.com

Authentication: Bearer · API key

Use the v1/recurrency route to create a charge that repeats every cycle. With Pix Automático the recurrence starts as PENDING and waits for the payer to authorize it. With card, the acquirer may already charge the first installment on creation, and then it starts as ACTIVE or FAILED; if the charge is left for later, it starts as PENDING and becomes ACTIVE once the first charge is paid.

Request body

Sent as JSON.

amountintegerrequired
Amount charged each cycle in cents. Example: R$ 1,00.
currencystringrequired
Recurrence currency. Today only BRL has a recurrence method.
methodstringrequired
Recurrence method (PIXAUTOMATIC, CREDIT_CARD).
descriptionstringrequired
Recurrence description. It goes to the acquirer and the payer sees it on the statement and in their notices.
frequencystringrequired
Charge frequency (WEEKLY, MONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY).
customerobjectrequired5 fields
Data of whoever is paying the recurrence.
- namestringrequired
  Full name of the payer.
- taxIdstringrequired
  Payer document.
- emailstringrequired
  Payer email address.
- phonestring
  Payer phone number. May be required by some processors.
- addressobjectrequired8 fields
  Billing address.
  - countrystringrequired
    Country code following ISO 3166-1 alpha-2 standard (e.g., BR, US).
  - statestringrequired
    State or province (e.g., SP, CA, NY). Used when country = BR.
  - citystringrequired
    City. Required when country = BR.
  - districtstringrequired
    District or neighborhood. Required when country = BR.
  - streetstringrequired
    Street name. Required when country = BR.
  - numberstringrequired
    Address number. Required when country = BR.
  - complementstring
    Address complement (apartment, building, unit, etc).
  - zipCodestringrequired
    ZIP code or postal code.
externalRefstring
External reference of the recurrence.
notificationUrlstring
URL where the recurrence webhooks will be sent.
splitsarray of strings
List of split IDs. Example: ["split_id_1", "split_id_2"].
metadataobject10 fields
Payment metadata used for tracking and auditing.
- providerstringrequired
  Source responsible for creating the payment.
- orderIdstringrequired
  Unique order identifier.
- sellerTaxIdstringrequired
  Seller tax document.
- sellerEmailstringrequired
  Seller email address.
- checkoutUrlstring
  Checkout URL.
- memberProductUrlstring
  Members area product page that originated the purchase.
- returnUrlstring
  Return URL after payment.
- shopUrlstring
  Sales or offer page.
- referrerLinkstring
  Immediate referrer URL.
- extrastring
  Free field for additional metadata.

Responses

200Recurrence created. The status depends on the method and on whether the acquirer charged right away: PENDING, ACTIVE or FAILED.

403The store is not allowed to use recurrence for this method or currency.

422The amount is outside the minimum or maximum ticket configured for the store.

messagestring
Error description message.
detailsobject
Additional error details.

400Validation error in the request body.

Something wrong on this page? Talk to us