Skip to content

fix(docs): correct JSON payment examples #1074

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matoous merged 3 commits into from
Oct 26, 2026
Merged

fix(docs): correct JSON payment examples #1074

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a478661
fix(docs): use public keys in React Native checkout
matoous Oct 26, 2026
4cd2a0b
fix(docs): validate JSON payment examples
matoous Oct 26, 2026
f243528
chore: remove JSON example checks
matoous Oct 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions src/content/docs/online-payments/apm/integration-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,16 +86,14 @@ In the Redirect Flow, when the checkout is processed, you receive the `"status":

```json
{
...
"status": "pending",
"next_step": {
"url": "https://apm-redirect-link",
"method": "POST",
"payload": {
"....": "..."
}
},
...
}
}
```

Expand Down
5 changes: 1 addition & 4 deletions src/content/docs/online-payments/guides/refund.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,13 +103,10 @@ The response contains a JSON body with the full details of the processed checkou
```json
{
"checkout_reference": "CO287866",
...
"id": "4ebc2ed7-bb8c-4d4d-a110-08fd31301bf2",
...
"transactions": [
{
"id": "664200af-2b62-4142-9c73-a2a505310d78",
...
"id": "664200af-2b62-4142-9c73-a2a505310d78"
}
]
}
Expand Down
14 changes: 7 additions & 7 deletions src/content/docs/online-payments/guides/tokenization-with-payment-sdk.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,8 +441,10 @@ The customer enters their card details, consents to storing them, and completes
If the previous operation is successful, and the card is stored with the **Save for future payments option**, a `payment_instrument` object containing a `token` representing the card is created (AKA tokenized card) for this customer.

```json
"payment_instrument": {
{
"payment_instrument": {
"token": "6878cb7f-6515-47bf-bdd9-1408d270fdce"
}
}
```

Expand Down Expand Up @@ -502,15 +504,14 @@ requesting them via [the list payment instruments](/api/customers/list-payment-i

Having successfully processed the checkout, a token representing the payment instrument (card) is created. You can now [retrieve the checkout](/api/checkouts/get) to find this token within a `payment_instrument` object for later recurrent payment.

Example response:
Relevant fields from the response:

```json
{
"id": "cd36780e-f43d-4f22-1i9e-e32a1a1bafc8",
"checkout_reference": "0BYNWLYC7KV",
"amount": 3.51,
"currency": "EUR",
...
"payment_instrument": {
"token": "2fa27578-e765-5dbh-aa97-d45d3d6cdfbb"
}
Expand All @@ -522,14 +523,13 @@ Example response:
Having tokenized the customer's card, you can now process recurring payments by referencing the saved token and the associated customer. Both `token` and `customer_id` fields are required.

1. [Create a checkout](/api/checkouts/create) again. This time, it's for the actual payment. The previous checkout was for tokenizing the card only.
2. Process the checkout. Make sure to pass the following data (`installments` is only valid for the Brazilian market):
2. Process the checkout with the saved token and customer ID. Add `installments` only for payments that require it in the Brazilian market:

```json
{
"payment_type": "card",
"installments": 1,
"token": "{{CARD_TOKEN}}"
"customer_id": "{{CUSTOMER_ID}}",
"token": "{{CARD_TOKEN}}",
"customer_id": "{{CUSTOMER_ID}}"
}
```

Expand Down
Loading
Loading