Non-Instant Local Payment Methods
Requirements
- In order to use this API, you must have created and linked your PayPal account with login credentials to the Braintree control panel.
- This API is available for all merchants to test in sandbox. For production usage, your account must be enabled to use this feature. Please contact Braintree Support for further assistance.
Creating Non-Instant Local Payment Contexts
To create a non-instant local payment context, you will specify all relevant transaction information for that payment scheme.
Braintree currently supports the following non-instant payment schemes:
- Boleto Bancário
- Multibanco
- OXXO
Capturing Non-Instant Transactions
There is no capture call for non-instant transactions; Braintree will associate a transaction on behalf of the merchant once we receive confirmation that the voucher has been paid.
SANDBOX
Use the approval url from the mutation response to display a modal in which you can simulate a successful payment, an expired payment, or an unapproved payment.
- Successful payment: a webhook will be sent to the merchant in 2-3 minutes and the payment context will update to show an associated transaction in a settled state.
- Expired payment: a webhook will be sent to the merchant in 2-3 minutes and the payment context will be expired.
- Unapproved payment: the payment context will be expired.
Boleto Bancario
Required fields
amount
- the amount of the order.payerInfo/billingAddress
- the billing address of the buyer.payerInfo/givenName
- the given name of the buyer.payerInfo/surname
- the given surname of the buyer.payerInfo/taxInfo/identifier
- this is the unique tax identifier for residents of Brazil.payerInfo/taxInfo/type
- this will beBR_CPF
for personal accounts andBR_CNPJ
for business accounts.type
- this must beBOLETOBANCARIO
.
Optional fields
expiryDate
- ifexpiryDate
is omitted, it will default totoday + 3 days
.orderId
- this will be a merchant-generated identifier for the order.
mutation
mutation CreateNonInstantLocalPaymentContext($input: CreateNonInstantLocalPaymentContextInput!) {createNonInstantLocalPaymentContext(input: $input) {paymentContext {idtypepaymentIdapprovalUrlmerchantAccountIdcreatedAttransactedAtapprovedAtamount {valuecurrencyCode}}}}
variables
{"input": {"paymentContext": {"amount": {"value": 1.23,"currencyCode": "BRL"},"type": "BOLETOBANCARIO","countryCode": "BR","returnUrl": "https://example.com/return","cancelUrl": "https://example.com/cancel","merchantAccountId": "a_merchant_account_id","payerInfo": {"givenName": "John","surname": "Doe","email": "john.doe@paypal.com","taxInfo": {"identifier": "1234567890","type": "BR_CNPJ"},"billingAddress": {"streetAddress": "1234 Main Street","extendedAddress": "#456","locality": "São Paulo","region": "SP","postalCode": "12345-678","countryCode": "BR"}}}}}
response
{"data": {"createNonInstantLocalPaymentContext": {"paymentContext": {"id": "a_payment_context_id","type": "BOLETOBANCARIO","paymentId": "a_payment_id","approvalUrl": "https://example.com/approval","merchantAccountId": "a_merchant_account_id","createdAt": "2021-07-28","transactedAt": "2021-07-28","approvedAt": "2021-07-28","amount": {"value": 1.23,"currencyIsoCode": "BRL"}}},"extensions": {"requestId": "abc-123-def-456"}}
Multibanco
Required fields
amount
- the amount of the order.payerInfo/givenName
- the given name of the buyer.payerInfo/surname
- the given surname of the buyer.type
- this must beMULTIBANCO
.
Optional fields
orderId
- this will be a merchant-generated identifier for the order.
Ignored fields
expiryDate
- this value is not overrible; the value is alwaystoday + 7 days
.
mutation
mutation CreateNonInstantLocalPaymentContext($input: CreateNonInstantLocalPaymentContextInput!) {createNonInstantLocalPaymentContext(input: $input) {paymentContext {idtypepaymentIdapprovalUrlmerchantAccountIdcreatedAttransactedAtapprovedAtamount {valuecurrencyCode}}}}
variables
{"input": {"paymentContext": {"amount": {"value": 1.23,"currencyCode": "EUR"},"type": "MULTIBANCO","countryCode": "PT","returnUrl": "https://example.com/return","cancelUrl": "https://example.com/cancel","merchantAccountId": "a_merchant_account_id","payerInfo": {"givenName": "John","surname": "Doe"}}}}
response
{"data": {"createNonInstantLocalPaymentContext": {"paymentContext": {"id": "a_payment_context_id","type": "multibanco","paymentId": "a_payment_id","approvalUrl": "https://example.com/approval","merchantAccountId": "a_merchant_account_id","createdAt": "2021-07-28","transactedAt": "2021-07-28","approvedAt": "2021-07-28","amount": {"value": 1.23,"currencyIsoCode": "EUR"}}},"extensions": {"requestId": "abc-123-def-456"}}
OXXO
Required fields
amount
- the amount of the order.payerInfo/billingAddress
- the billing address of the buyer.payerInfo/givenName
- the given name of the buyer.payerInfo/surname
- the given surname of the buyer.type
- this must beOXXO
.
Optional fields
expiryDate
- ifexpiryDate
is omitted, it will default totoday + 3 days
.orderId
- this will be a merchant-generated identifier for the order.
mutation
mutation CreateNonInstantLocalPaymentContext($input: CreateNonInstantLocalPaymentContextInput!) {createNonInstantLocalPaymentContext(input: $input) {paymentContext {idtypepaymentIdapprovalUrlmerchantAccountIdcreatedAttransactedAtapprovedAtamount {valuecurrencyCode}}}}
variables
{"input": {"paymentContext": {"amount": {"value": 1.23,"currencyCode": "MXN"},"type": "OXXO","countryCode": "MX","returnUrl": "https://example.com/return","cancelUrl": "https://example.com/cancel","merchantAccountId": "a_merchant_account_id","payerInfo": {"givenName": "John","surname": "Doe","email": "john.doe@example.com"}}}}
response
{"data": {"createNonInstantLocalPaymentContext": {"paymentContext": {"id": "a_payment_context_id","type": "oxxo","paymentId": "a_payment_id","approvalUrl": "https://example.com/approval","merchantAccountId": "a_merchant_account_id","createdAt": "2021-07-28","transactedAt": "2021-07-28","approvedAt": "2021-07-28","amount": {"value": 1.23,"currencyIsoCode": "MXN"}}},"extensions": {"requestId": "abc-123-def-456"}}
Error Samples
General API error documentation
errors
{"errors": [{"message": "Presentment currency code USD is invalid for funding source oxxo""locations": [{"line": 2,"column": 3}],"path": ["createNonInstantLocalPaymentContext"],"extensions": {"errorClass": "VALIDATION","errorType": "user_error","inputPath": ["input","paymentContext"]}}],"data": {"createNonInstantLocalPaymentContext": null},"extensions": {"requestId": "abc-123-def-456"}}
errors
{"errors": [{"message": "The requested action could not be performed, semantically incorrect, or failed business validation.","locations": [{"line": 2,"column": 3}],"path": ["createNonInstantLocalPaymentContext"],"extensions": {"errorClass": "VALIDATION","errorType": "user_error","inputPath": ["input","paymentContext"]}}],"data": {"createNonInstantLocalPaymentContext": null},"extensions": {"requestId": "abc-123-def-456"}}