Create Payment

This endpoint creates a payment with configurable due date.

POST /payments

Create Payment

cURL

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": "[e-mail]",
  "phoneNumber": "[phone]",
  "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"
}

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

Show Mostrar objeto

id · number

Unique payment identifier.

amount · number

Payment amount.

description · string

Payment description.

clientMode · string

Customer data handling mode.

redirect_url · string

Redirect URL.

email · string

Customer email.

phoneNumber · string

Customer phone number.

document_type · string

Customer document type.

expire_at · string

Payment expiration date.

document_client · string

Customer document.

document_type_client · string

Customer document type.

name_client · string

Customer name.

external_reference · string

External reference for your application.

id_transaction · string

Transaction identifier.

transaction_pix_id · string

Pix transaction identifier.

emv · string

Pix EMV code.

name_receiver · string

Receiver name.

document_receiver · string

Receiver document.

document_type_receiver · string

Receiver document type.

qr_image · string

Base64 QR code for Pix payment.

qr_text · string

Pix QR code text.

status · string

Current payment status.

checkout_id · string

Generated checkout identifier.

createdAt · string

Payment creation date (timezone: America/Sao_Paulo).

updatedAt · string

Payment update date (timezone: America/Sao_Paulo).

{
  "id": 12345,
  "amount": 150.5,
  "description": "Pagamento mensalidade",
  "clientMode": "fillDataNow",
  "redirect_url": "https://minhaapp.com/retorno",
  "email": "[e-mail]",
  "phoneNumber": "[phone]",
  "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"
}