Pular para o conteúdo principal
POST
/
transactions
/
{transactionId}
/
payments
/
process
Processar payments
curl --request POST \
  --url https://api.sandbox.z2pay.com/transactions/{transactionId}/payments/process \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "customer": {
    "name": "<string>",
    "email": "jsmith@example.com",
    "document": "<string>"
  },
  "creditCard": {
    "cardId": "<string>",
    "token": "<string>",
    "billingAddress": {
      "street": "<string>",
      "number": "<string>",
      "complement": "<string>",
      "neighborhood": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "zipCode": "<string>"
    }
  },
  "ip": "<string>",
  "metadata": {},
  "routerConfigId": "<string>",
  "availableGatewayConfigIds": [
    "<string>"
  ],
  "paymentIds": [
    "<string>"
  ]
}
'
Processa os payments pendentes da transação via gateway. O endpoint executa o routing para selecionar o gateway e cria o ciclo de pagamento. Por padrão, são processados todos os payments da transação em status pending ou waiting_payment. Você pode restringir a payments específicos enviando paymentIds.
Este endpoint suporta idempotência. Envie o header Idempotency-Key com um valor único por requisição para evitar processamentos duplicados em caso de retry.
Os campos creditCard, boleto e pix são opcionais no schema, mas você precisa enviar o objeto correspondente ao paymentMethod dos payments que está processando — caso contrário o gateway não consegue concluir o pagamento.
Se não houver nenhum payment pendente para processar, a resposta (200) traz results vazio e uma mensagem informativa em vez da contagem de processamento.

Autorizações

​
x-api-key
string
header
obrigatório

API Key da Credential (gerada no Backoffice)

Cabeçalhos

​
Idempotency-Key
string

Chave única para garantir idempotência da requisição

Parâmetros de caminho

​
transactionId
string
obrigatório

ID da transação

Corpo

application/json
​
customer
object
obrigatório
​
creditCard
object
​
boleto
object
​
pix
object
​
ip
string
​
metadata
object
​
routerConfigId
string
​
availableGatewayConfigIds
string[]
​
paymentIds
string[]

Resposta

Resultado do processamento dos payments