Schedule an authorization for recurring payment
Environment | Method | Endpoint |
---|---|---|
Sandbox | post | https://apisandbox.braspag.com.br/v2/sales/ |
Production | post | https://api.braspag.com.br/v2/sales/ |
Request
{
"MerchantOrderId":"2017091101",
"Customer":{
"Name":"Nome do Comprador",
"Identity":"12345678909",
"IdentityType":"CPF",
"Address":{
"Street":"Alameda Xingu",
"Number":"512",
"Complement":"27 andar",
"ZipCode":"12345987",
"City":"São Paulo",
"State":"SP",
"Country":"BRA",
"District":"Alphaville"
}
},
"Payment":{
"Provider":"Simulado",
"Type":"CreditCard",
"Amount":10000,
"Installments":1,
"CreditCard":{
"CardNumber":"4551870000000181",
"Holder":"Nome do Portador",
"ExpirationDate":"12/2021",
"SecurityCode":"123",
"Brand":"Visa"
},
"RecurrentPayment":{
"AuthorizeNow":false,
"StartDate":"2017-12-31",
"EndDate":"2019-12-31",
"Interval":"Monthly"
}
}
}
Property | Description | Type | Size | Required? |
---|---|---|---|---|
Payment.Provider | Name of the payment method provider. | Text | 15 | Yes |
Payment.Type | Payment method type. | Text | 100 | Yes |
Payment.Amount | Order amount in cents. | Number | 15 | Yes |
Payment.Installments | Number of installments. | Number | 2 | Yes |
Payment.RecurrentPayment.StartDate | Recurrence start date. | Text | 10 | No |
Payment.RecurrentPayment.EndDate | Recurrence end date. | Text | 10 | No |
Payment.RecurrentPayment.Interval | Recurrence Interval. Monthly (Default) / Bimonthly / Quarterly / SemiAnnual / Annual. | Text | 10 | No |
Payment.RecurrentPayment.AuthorizeNow | "true" - authorizes right at request. / "false" - for future scheduling. | Boolean | *** | Yes |
CreditCard.CardNumber | Customer’s card number. | Text | 19 | Yes |
CreditCard.Holder | Name of cardholder printed on the card. | Text | 25 | Yes |
CreditCard.ExpirationDate | Expiration date printed on the card, in the MM/YYYY format. | Text | 7 | Yes |
CreditCard.SecurityCode | Security code printed on the back of the card. | Text | 4 | Yes |
CreditCard.Brand | Card brand. | Text | 10 | Yes |
Response
{
[...]
"Payment":{
"ServiceTaxAmount": 0,
"Installments":1,
"Interest":"ByMerchant",
"Capture":true,
"Authenticate":false,
"Recurrent":false,
"CreditCard":{
"CardNumber": "455187******0181",
"Holder": "Cardholder Name",
"ExpirationDate":"12/2021",
"SaveCard":"false",
"Brand": "Undefined"
},
"Type":"CreditCard",
"Amount":10000,
"Currency":"BRL",
"Country":"BRA",
"Provider":"Simulado",
Status 20
"RecurrentPayment": {
"RecurrentPaymentId": "32703035-7dfb-4369-ac53-34c7ff7b84e8",
"ReasonCode": 0,
"ReasonMessage": "Successful",
"NextRecurrency": "2017-12-31",
"StartDate": "2017-12-31",
"EndDate":"2019-12-31",
"Interval": "Monthly",
[...]
"AuthorizeNow": false
}
}
}
Property | Description | Type | Size | Format |
---|---|---|---|---|
RecurrentPaymentId | Field identifier of the next recurrence. | GUID | 36 | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
NextRecurrency | Date of next recurrence. | Text | 7 | 05/2019 (MM/YYYY) |
StartDate | Start date of recurrence. | Text | 7 | 05/2019 (MM/YYYY) |
EndDate | End date of recurrence. | Text | 7 | 05/2019 (MM/YYYY) |
Interval | Interval between recurrences. | Text | 10 | Monthly / Bimonthly / Quarterly / SemiAnnual / Annual |
AuthorizeNow | Whether the first recurrence will already be authorized or not. | Boolean | *** | "true" / "false" |