Pular para o conteúdo principal
POST
/
v1
/
payments
Criar um pagamento PIX
curl --request POST \
  --url https://api.paybridge.dev/v1/payments \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "amount": 10,
  "credentialId": "<string>",
  "ruleSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "Pagamento do pedido #123",
  "externalId": "pedido-123",
  "payer": {
    "name": "João Silva",
    "document": "12345678900",
    "email": "joao@exemplo.com.br",
    "phone": "11999999999"
  },
  "expirationMinutes": 30,
  "metadata": {
    "orderId": "123",
    "source": "mobile"
  }
}
'
{
  "id": "<string>",
  "amount": 123,
  "currency": "<string>",
  "status": "<string>",
  "provider": "<string>",
  "pixCopyPaste": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "pixQrCodeBase64": "<string>",
  "isTest": true,
  "metadata": {
    "orderId": "123",
    "source": "mobile"
  }
}

Autorizações

​
X-API-Key
string
header
obrigatório

API Key para autenticação (pk_live_* ou pk_test_*)

Corpo

application/json
​
amount
number
obrigatório

Valor em BRL (ex: 10.00 para R$ 10,00)

Exemplo:

10

​
credentialId
string

ID da credencial a ser usada para este pagamento. Se fornecido, ignora as regras do rule set. Se nem credentialId nem ruleSetId forem fornecidos, a credencial padrão será usada.

​
ruleSetId
string<uuid>

ID do Rule Set para roteamento de credenciais. Quando fornecido, as regras do rule set serão usadas para selecionar a credencial primária e fallbacks. Se não fornecido, a credencial padrão será usada.

​
description
string

Descrição do pagamento

Exemplo:

"Pagamento do pedido #123"

​
externalId
string

ID de referência externa

Exemplo:

"pedido-123"

​
payer
object
​
expirationMinutes
number
padrão:30

Tempo de expiração em minutos

Intervalo obrigatório: x >= 5
​
metadata
object

Metadados customizados (objeto JSON)

Exemplo:
{ "orderId": "123", "source": "mobile" }

Resposta

Pagamento criado com sucesso

​
id
string
obrigatório

ID único do pagamento

​
amount
number
obrigatório

Valor do pagamento

​
currency
string
obrigatório

Moeda (BRL)

​
status
string
obrigatório

Status do pagamento

​
provider
string
obrigatório

Provedor de pagamento

​
pixCopyPaste
string
obrigatório

Código PIX copia e cola

​
expiresAt
string<date-time>
obrigatório

Data de expiração

​
createdAt
string<date-time>
obrigatório

Data de criação

​
pixQrCodeBase64
string

QR Code em Base64

​
isTest
boolean

Se é um pagamento de teste/sandbox

​
metadata
object

Metadados customizados

Exemplo:
{ "orderId": "123", "source": "mobile" }