DesenvolvedoresReferência da APICheckout

Pagar de novo um pedido pendente

POST
/orders/{orderId}/payments

Nova tentativa de pagamento de um pedido pendente cujo último pagamento foi recusado, expirou, foi cancelado ou ficou sem cobrança porque o gateway não respondeu (502 payment_provider_unavailable), por exemplo para trocar um cartão recusado por Pix. Exige o X-Order-Token (o accessToken devolvido pelo checkout). Cada tentativa cria um novo pagamento no mesmo pedido; a exceção é a cobrança que o gateway não chegou a criar: com a mesma forma de pagamento, ela é refeita no mesmo pagamento, sem risco de cobrar duas vezes. Outra recusa responde 402 payment_declined.

Chave: Chave publicável ou secreta.

Escopo: checkout:write.

Idempotência: aceita o cabeçalho Idempotency-Key.

Limite: 20 requisições a cada 1 min, além do limite geral de 600 por minuto por chave.

Autorização

headerAutorizaçãoBearer <chave de API>

Chave publicável (pk_…). Pode ir para o navegador; dá acesso só ao catálogo, ao carrinho e ao checkout.

Parâmetros de caminho

orderId*string
Formatouuid

Cabeçalhos

X-Order-Token*string

O accessToken devolvido pelo checkout.

Idempotency-Key?string

De 1 a 255 caracteres visíveis. Repetir a chamada com a mesma chave devolve a mesma resposta por 24 horas.

Corpo da requisição

application/json
  1. body
buyer*
payment*

Corpo da resposta

Criado.

application/json
  1. response
data*
meta*
curl -X POST 'https://minepag.com.br/api/v1/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08/payments' \  -H 'X-Order-Token: string' \  -H 'Content-Type: application/json' \  -d '{  "buyer": {    "name": "string",    "email": "user@example.com"  },  "payment": {    "method": "pix"  }}'
{  "data": {    "order": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "number": -9007199254740991,      "status": "pending",      "paymentStatus": "pending",      "subtotal": -9007199254740991,      "discountTotal": -9007199254740991,      "total": -9007199254740991,      "expiresAt": "2019-08-24T14:15:22Z"    },    "payment": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "method": "pix",      "status": "pending",      "amount": -9007199254740991,      "instructions": {        "method": "pix",        "copyPaste": "string",        "qrCodeImage": "string",        "expiresAt": "2019-08-24T14:15:22Z"      },      "clientAction": {        "kind": "redirect",        "url": "string"      },      "failureReason": "string"    },    "accessToken": "string",    "orderUrl": "string"  },  "meta": {    "requestId": "string"  }}