Pay an invoice at checkout
curl --request POST \
--url https://api-sandbox.beinfi.com/pay/{slug}/invoices/{invoiceID}/charge \
--header 'Content-Type: application/json' \
--data '
{
"remember": true,
"rememberTextVersion": "<string>",
"surface": "embed",
"autoTopup": true,
"withdrawalWaiver": true,
"quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": 2,
"consentDigest": "<string>",
"taxId": "<string>",
"phone": "<string>"
}
'import requests
url = "https://api-sandbox.beinfi.com/pay/{slug}/invoices/{invoiceID}/charge"
payload = {
"remember": True,
"rememberTextVersion": "<string>",
"surface": "embed",
"autoTopup": True,
"withdrawalWaiver": True,
"quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": 2,
"consentDigest": "<string>",
"taxId": "<string>",
"phone": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
remember: true,
rememberTextVersion: '<string>',
surface: 'embed',
autoTopup: true,
withdrawalWaiver: true,
quoteId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
revision: 2,
consentDigest: '<string>',
taxId: '<string>',
phone: '<string>'
})
};
fetch('https://api-sandbox.beinfi.com/pay/{slug}/invoices/{invoiceID}/charge', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.beinfi.com/pay/{slug}/invoices/{invoiceID}/charge",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'remember' => true,
'rememberTextVersion' => '<string>',
'surface' => 'embed',
'autoTopup' => true,
'withdrawalWaiver' => true,
'quoteId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'revision' => 2,
'consentDigest' => '<string>',
'taxId' => '<string>',
'phone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.beinfi.com/pay/{slug}/invoices/{invoiceID}/charge"
payload := strings.NewReader("{\n \"remember\": true,\n \"rememberTextVersion\": \"<string>\",\n \"surface\": \"embed\",\n \"autoTopup\": true,\n \"withdrawalWaiver\": true,\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"revision\": 2,\n \"consentDigest\": \"<string>\",\n \"taxId\": \"<string>\",\n \"phone\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.beinfi.com/pay/{slug}/invoices/{invoiceID}/charge")
.header("Content-Type", "application/json")
.body("{\n \"remember\": true,\n \"rememberTextVersion\": \"<string>\",\n \"surface\": \"embed\",\n \"autoTopup\": true,\n \"withdrawalWaiver\": true,\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"revision\": 2,\n \"consentDigest\": \"<string>\",\n \"taxId\": \"<string>\",\n \"phone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.beinfi.com/pay/{slug}/invoices/{invoiceID}/charge")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"remember\": true,\n \"rememberTextVersion\": \"<string>\",\n \"surface\": \"embed\",\n \"autoTopup\": true,\n \"withdrawalWaiver\": true,\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"revision\": 2,\n \"consentDigest\": \"<string>\",\n \"taxId\": \"<string>\",\n \"phone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "pay_585vbbvnwDyuyeA3MTOitd",
"invoiceId": "inv_6yi30EKotIwGHZdePSdsFc",
"provider": "<string>",
"method": "pix",
"amount": "<string>",
"currency": "<string>",
"status": "pending",
"createdAt": "2023-11-07T05:31:56Z",
"switchable": true,
"providerId": "<string>",
"refundedAmount": "<string>",
"failureCode": "insufficient_funds",
"failedAt": "2023-11-07T05:31:56Z",
"payer": {
"id": "cus_6Tq0Y2rGJ1aQ9zXk3LmPbV",
"name": "<string>",
"email": "<string>"
},
"invoiceUrl": "<string>",
"pixPayload": "<string>",
"pixQrImage": "<string>",
"pixExpiresAt": "2023-11-07T05:31:56Z",
"checkoutAction": {
"kind": "stripe_checkout_elements",
"paymentId": "pay_585vbbvnwDyuyeA3MTOitd",
"clientSecret": "<string>",
"publishableKey": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"mode": "payment",
"mandate": {
"version": "<string>",
"text": "<string>"
}
}
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"resource": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"resource": "<string>",
"metadata": {}
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"errors": [
{
"field": "<string>",
"value": "<string>",
"constraint": "<string>",
"description": "<string>"
}
]
}{
"error": {
"code": "internal_error",
"message": "<string>",
"request_id": "<string>"
}
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>"
}Checkout
Pay an invoice at checkout
Creates a charge on an open invoice using the method the payer picked: pix or card (single payment), both in test environment. boleto is coming soon. The response carries what the payer needs to finish, such as the Pix QR code. Confirmation comes later: poll the payment status or wait for the payment.confirmed webhook.
POST
/
pay
/
{slug}
/
invoices
/
{invoiceID}
/
charge
Pay an invoice at checkout
curl --request POST \
--url https://api-sandbox.beinfi.com/pay/{slug}/invoices/{invoiceID}/charge \
--header 'Content-Type: application/json' \
--data '
{
"remember": true,
"rememberTextVersion": "<string>",
"surface": "embed",
"autoTopup": true,
"withdrawalWaiver": true,
"quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": 2,
"consentDigest": "<string>",
"taxId": "<string>",
"phone": "<string>"
}
'import requests
url = "https://api-sandbox.beinfi.com/pay/{slug}/invoices/{invoiceID}/charge"
payload = {
"remember": True,
"rememberTextVersion": "<string>",
"surface": "embed",
"autoTopup": True,
"withdrawalWaiver": True,
"quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": 2,
"consentDigest": "<string>",
"taxId": "<string>",
"phone": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
remember: true,
rememberTextVersion: '<string>',
surface: 'embed',
autoTopup: true,
withdrawalWaiver: true,
quoteId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
revision: 2,
consentDigest: '<string>',
taxId: '<string>',
phone: '<string>'
})
};
fetch('https://api-sandbox.beinfi.com/pay/{slug}/invoices/{invoiceID}/charge', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.beinfi.com/pay/{slug}/invoices/{invoiceID}/charge",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'remember' => true,
'rememberTextVersion' => '<string>',
'surface' => 'embed',
'autoTopup' => true,
'withdrawalWaiver' => true,
'quoteId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'revision' => 2,
'consentDigest' => '<string>',
'taxId' => '<string>',
'phone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.beinfi.com/pay/{slug}/invoices/{invoiceID}/charge"
payload := strings.NewReader("{\n \"remember\": true,\n \"rememberTextVersion\": \"<string>\",\n \"surface\": \"embed\",\n \"autoTopup\": true,\n \"withdrawalWaiver\": true,\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"revision\": 2,\n \"consentDigest\": \"<string>\",\n \"taxId\": \"<string>\",\n \"phone\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.beinfi.com/pay/{slug}/invoices/{invoiceID}/charge")
.header("Content-Type", "application/json")
.body("{\n \"remember\": true,\n \"rememberTextVersion\": \"<string>\",\n \"surface\": \"embed\",\n \"autoTopup\": true,\n \"withdrawalWaiver\": true,\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"revision\": 2,\n \"consentDigest\": \"<string>\",\n \"taxId\": \"<string>\",\n \"phone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.beinfi.com/pay/{slug}/invoices/{invoiceID}/charge")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"remember\": true,\n \"rememberTextVersion\": \"<string>\",\n \"surface\": \"embed\",\n \"autoTopup\": true,\n \"withdrawalWaiver\": true,\n \"quoteId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"revision\": 2,\n \"consentDigest\": \"<string>\",\n \"taxId\": \"<string>\",\n \"phone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "pay_585vbbvnwDyuyeA3MTOitd",
"invoiceId": "inv_6yi30EKotIwGHZdePSdsFc",
"provider": "<string>",
"method": "pix",
"amount": "<string>",
"currency": "<string>",
"status": "pending",
"createdAt": "2023-11-07T05:31:56Z",
"switchable": true,
"providerId": "<string>",
"refundedAmount": "<string>",
"failureCode": "insufficient_funds",
"failedAt": "2023-11-07T05:31:56Z",
"payer": {
"id": "cus_6Tq0Y2rGJ1aQ9zXk3LmPbV",
"name": "<string>",
"email": "<string>"
},
"invoiceUrl": "<string>",
"pixPayload": "<string>",
"pixQrImage": "<string>",
"pixExpiresAt": "2023-11-07T05:31:56Z",
"checkoutAction": {
"kind": "stripe_checkout_elements",
"paymentId": "pay_585vbbvnwDyuyeA3MTOitd",
"clientSecret": "<string>",
"publishableKey": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"mode": "payment",
"mandate": {
"version": "<string>",
"text": "<string>"
}
}
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"resource": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"resource": "<string>",
"metadata": {}
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"errors": [
{
"field": "<string>",
"value": "<string>",
"constraint": "<string>",
"description": "<string>"
}
]
}{
"error": {
"code": "internal_error",
"message": "<string>",
"request_id": "<string>"
}
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>"
}Path Parameters
Your account's public identifier, as in checkout URLs.
Invoice ID.
Pattern:
^inv_[0-9A-Za-z]{22}$Example:
"inv_6yi30EKotIwGHZdePSdsFc"
Body
application/json
The method the payer picked. A missing or unknown method returns 422.
Payment method.
Available options:
pix, card Which Infi checkout the payer is on. It sets where the browser returns after a bank verification. Use embed from an embedded (iframe) checkout; without it, hosted applies and the payer leaves the iframe for the full page.
Available options:
embed Required range:
x >= 1Response
The created charge.
One charge attempt against an invoice. An invoice can have several payments.
Pattern:
^pay_[0-9A-Za-z]{22}$Example:
"pay_585vbbvnwDyuyeA3MTOitd"
Pattern:
^inv_[0-9A-Za-z]{22}$Example:
"inv_6yi30EKotIwGHZdePSdsFc"
The processor the charge ran through. In sandbox, sandbox.
Available options:
pix, card Amount charged, as a decimal string.
pending awaits payment; confirmed was paid; failed was not paid (see failureCode); refunded was fully refunded; charged_back was disputed by the buyer with their bank.
Available options:
pending, confirmed, failed, refunded, charged_back Whether this charge can still be dropped so the same invoice is paid another way: true while pending, false once paid or failed. Present only on the charge-creation response; treat a missing value as false.
The charge's reference at the processor, useful for support.
Total refunded so far, as a decimal string. Absent when nothing was refunded. A partial refund keeps status at confirmed; only refunding the full amount sets refunded. Use this field, not status, to know how much went back.
Why the charge failed. superseded is not a decline: the buyer switched payment method to pay the same invoice. Null when the payment did not fail or when no reason was recorded. New codes may appear; treat an unknown value as a generic failure.
Available options:
insufficient_funds, do_not_honor, card_declined, authentication_required, card_expired, card_stolen, card_invalid, mandate_revoked, mandate_refused, brand_changed, provider_error, provider_timeout, superseded, null When the charge moved to failed.
Who paid. On a one-off invoice, id is the customer ID; on a subscription invoice, it is the ID of the customer's enrollment in the product. Present only on GET /billing/payments and GET /billing/payments/{paymentID}, and null when the invoice does not identify the customer.
Show child attributes
Show child attributes
Hosted payment page. Present only on the charge-creation response.
Pix copy-and-paste code. Render the QR from it. Still available on later reads of the payment.
The Pix QR as a base64 PNG (no data: prefix), if you would rather not render it yourself.
When the Pix code expires (Pix charges only).
What is needed to mount a card payment on an international sale through BEINFI LTD. Coming soon.
Show child attributes
Show child attributes