API Reference

Create a credit card transaction with recurrence

post
https://api-sandbox.astrapay.com.br/card/v1/credit/recurrence
Body Params
string
enum
required

Type of the Recurrence. LIMITED_TIMES:
A fixed quantity of credit card transactions will be scheduled with the frequency informed in the field recurrenceFrequency. This should be informed in the field numberInstallments\r\nINDERTERMINATE: In this case, a credit card transaction will continue to be generated according to the frequency for an indefinite period of time until the recurrence is cancelled. When this option is selected, the numberInstallments field must be null

Allowed:
string
enum
required

Frequency of the Recurrence. How often the credit card transaction will be generated. Should be DAILY, WEEKLY, MONTHLY or YEARLY

Allowed:
date
required

Date of the first credit card transaction in the format yyyy-MM-dd

int32

Number of times the recurrence will be executed. Should be null if recurrenceType is INDETERMINATE

double
required
≥ 0.01

Amount of each recurrence installment

string
required

Card number

string
required

Card expiration date - Format (month and year)yyyymmm

string
required
length between 3 and 3

Security code CVV

boolean

flag used for recurrences with a start date in the future. If marked as true, a charge of R$ 5,00 will be made to the card to validate the data. It will be canceled immediately afterwards.

string
required

Name printed on credit card

string
required

Card owner document number

string

Optional information provided by the client. Can be an internal id for tracking the request.

string
length between 0 and 100

Transaction description

int32

Maximum number of failed attempts before the recurrence is automatically canceled

infoData
object
required
Headers
string

Transaction UUID

Responses

Updated 5 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago