Checkout

curl --request POST \
--url https://app.amplopay.com/api/v1/gateway/checkout \
--header 'Content-Type: application/json' \
--header 'x-public-key: SUA_CHAVE_PUBLICA_AQUI' \
--header 'x-secret-key: SUA_CHAVE_PRIVADA_AQUI' \
--data '{
"product": {
"name": "Produto de Teste",
"externalId": "A-10",
"photos": ["https://example.com/image.jpg"],
"offer": {
"name": "Oferta Padrão",
"price": 40000,
"offerType": "NATIONAL",
"currency": "all",
"lang": "pt-BR"
}
},
"settings": {
"paymentMethods": ["BOLETO", "PIX", "CREDIT_CARD"],
"acceptedDocs": ["CPF"],
"thankYouPage": "",
"askForAddress": false
},
"customer": {
"name": "Joao dos santos",
"email": "joao@gmail.com",
"phone": "7399999-9999",
"document": "098.232.664-43"
}
}'

{
    "success": true,
    "checkoutUrl": "https://apidaminhagateway.com.br/checkout/cmar9fp6700176uvcmjh6gjkd?offer=4a222a1f"
}

POST

gateway

checkout

curl --request POST \
--url https://app.amplopay.com/api/v1/gateway/checkout \
--header 'Content-Type: application/json' \
--header 'x-public-key: SUA_CHAVE_PUBLICA_AQUI' \
--header 'x-secret-key: SUA_CHAVE_PRIVADA_AQUI' \
--data '{
"product": {
"name": "Produto de Teste",
"externalId": "A-10",
"photos": ["https://example.com/image.jpg"],
"offer": {
"name": "Oferta Padrão",
"price": 40000,
"offerType": "NATIONAL",
"currency": "all",
"lang": "pt-BR"
}
},
"settings": {
"paymentMethods": ["BOLETO", "PIX", "CREDIT_CARD"],
"acceptedDocs": ["CPF"],
"thankYouPage": "",
"askForAddress": false
},
"customer": {
"name": "Joao dos santos",
"email": "joao@gmail.com",
"phone": "7399999-9999",
"document": "098.232.664-43"
}
}'

{
    "success": true,
    "checkoutUrl": "https://apidaminhagateway.com.br/checkout/cmar9fp6700176uvcmjh6gjkd?offer=4a222a1f"
}

Creates a checkout URL for a product and offer.

This endpoint depends on the PRODUCER_CHECKOUT permission and the company setting that allows checkout creation through the API.

Body parameters

object

required

Product details.

string

required

Product ID in the external platform.

string

required

Product name.

string[]

Product photo URLs.

object

required

Offer details.

string

required

Offer name.

number

required

Offer price.

string

required

Offer type.

string

required

Accepted currency, such as BRL, USD, or all.

string

required

Language/locale, such as pt-BR, or all.

object

Optional checkout settings.

string[]

Accepted payment methods. Defaults to all methods.

string[]

Accepted documents. Defaults to CPF.

string

Post-purchase redirect URL.

boolean

Whether checkout should ask for customer address. Defaults to false.

object

Checkout colors in hex format.

object

Customer data used to prefill checkout fields.

string

Customer name.

string

Customer email.

string

Customer phone.

string

Customer document.

object

Customer address used to prefill checkout fields.

Request example

curl --request POST \
--url https://app.amplopay.com/api/v1/gateway/checkout \
--header 'Content-Type: application/json' \
--header 'x-public-key: SUA_CHAVE_PUBLICA_AQUI' \
--header 'x-secret-key: SUA_CHAVE_PRIVADA_AQUI' \
--data '{
"product": {
"name": "Produto de Teste",
"externalId": "A-10",
"photos": ["https://example.com/image.jpg"],
"offer": {
"name": "Oferta Padrão",
"price": 40000,
"offerType": "NATIONAL",
"currency": "all",
"lang": "pt-BR"
}
},
"settings": {
"paymentMethods": ["BOLETO", "PIX", "CREDIT_CARD"],
"acceptedDocs": ["CPF"],
"thankYouPage": "",
"askForAddress": false
},
"customer": {
"name": "Joao dos santos",
"email": "joao@gmail.com",
"phone": "7399999-9999",
"document": "098.232.664-43"
}
}'

Response

boolean

required

Indicates whether the checkout was created successfully.

string

required

URL used to redirect the customer to checkout.

{
    "success": true,
    "checkoutUrl": "https://apidaminhagateway.com.br/checkout/cmar9fp6700176uvcmjh6gjkd?offer=4a222a1f"
}

⌘I

Getting started

Endpoints

Webhooks

FAQ

Body parameters

Request example

Response

​Body parameters

​Request example

​Response

Body parameters

Request example

Response