Skip to main content
POST
/
payments
Create Payment
curl --request POST \
  --url https://api.gates2b.com/payments \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientMode": "<string>",
  "amount": 123,
  "expire_at": "<string>",
  "description": "<string>",
  "external_reference": "<string>",
  "redirect_url": "<string>",
  "phoneNumber": "<string>",
  "email": "<string>",
  "document_type": "<string>",
  "name_client": "<string>",
  "document_client": "<string>"
}
'
{
  "id": 12345,
  "amount": 150.5,
  "description": "Pagamento mensalidade",
  "clientMode": "fillDataNow",
  "redirect_url": "https://minhaapp.com/retorno",
  "email": "cliente@exemplo.com",
  "phoneNumber": "+5511999999999",
  "document_type": "CPF",
  "expire_at": "2025-12-31T23:59:59Z",
  "document_client": "12345678900",
  "document_type_client": "CPF",
  "name_client": "João da Silva",
  "external_reference": "pedido-123",
  "id_transaction": "abc123xyz",
  "transaction_pix_id": "TRXPIX001",
  "emv": "00020101021226960014...",
  "name_receiver": "Empresa LTDA",
  "document_receiver": "11222333444455",
  "document_type_receiver": "CNPJ",
  "qr_image": "iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDol...",
  "qr_text": "00020101021226840014br.gov.bcb.pix2562...",
  "status": "Aguardando pagamento",
  "checkout_id": "ck_987654321",
  "createdAt": "2025-06-27T14:00:00-03:00",
  "updatedAt": "2025-06-27T14:00:00-03:00"
}

Documentation Index

Fetch the complete documentation index at: https://docs.gates2b.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Authorization
string
required
The Bearer authentication token is required to access this endpoint.
​
clientMode
string
required
Defines how customer data is handled. - noNeedToSpecify: No customer data required. - fillDataNow: Customer data must be provided now. - requestCheckout: Customer data will be collected via checkout.
​
amount
number
required
Payment amount.
​
expire_at
string
required
Expiration date and time in ISO 8601 format.
​
description
string
Payment description. Optional field.
​
external_reference
string
External reference for your application. Optional field.
​
redirect_url
string
Redirect URL after payment. Optional field.
​
phoneNumber
string
Customer phone number. Optional field.
​
email
string
Customer email. Optional field.
​
document_type
string
Customer document type. Optional field.
​
name_client
string
Customer name. Optional field.
​
document_client
string
Customer document. Optional field.

​
Response

​
status
number
HTTP response code. Expected: 201.
​
code
string
Internal operation code.
​
response
object
{
  "id": 12345,
  "amount": 150.5,
  "description": "Pagamento mensalidade",
  "clientMode": "fillDataNow",
  "redirect_url": "https://minhaapp.com/retorno",
  "email": "cliente@exemplo.com",
  "phoneNumber": "+5511999999999",
  "document_type": "CPF",
  "expire_at": "2025-12-31T23:59:59Z",
  "document_client": "12345678900",
  "document_type_client": "CPF",
  "name_client": "João da Silva",
  "external_reference": "pedido-123",
  "id_transaction": "abc123xyz",
  "transaction_pix_id": "TRXPIX001",
  "emv": "00020101021226960014...",
  "name_receiver": "Empresa LTDA",
  "document_receiver": "11222333444455",
  "document_type_receiver": "CNPJ",
  "qr_image": "iVBORw0KGgoAAAANSUhEUgAAAQAAAAEAAQMAAABmvDol...",
  "qr_text": "00020101021226840014br.gov.bcb.pix2562...",
  "status": "Aguardando pagamento",
  "checkout_id": "ck_987654321",
  "createdAt": "2025-06-27T14:00:00-03:00",
  "updatedAt": "2025-06-27T14:00:00-03:00"
}