DesenvolvedoresReferência da APIEntregas

Informar falha de serviço externo

POST
/deliveries/{id}/fail

O serviço externo informa que não conseguiu entregar. Com retryable: true, a MinePag agenda uma nova tentativa com intervalo crescente.

Chave: Só chave secreta (chamada pelo servidor).

Escopo: deliveries:write.

Autorização

chaveSecreta
headerAutorizaçãoBearer <chave de API>

Chave secreta (sk_…). Use só no servidor; requisições de navegador (com Origin) são recusadas.

Parâmetros de caminho

id*string

O operationId recebido em delivery.requested.

Formatouuid

Corpo da requisição

application/json
  1. body
code*string
Padrão^[a-z0-9_]{1,64}$
message*string
Tamanho1 <= length <= 500
retryable?boolean
Padrãofalse
externalReference?string
Tamanho1 <= length <= 255

Corpo da resposta

Sucesso.

application/json
  1. response
data*
meta*
curl -X POST 'https://minepag.com.br/api/v1/deliveries/497f6eca-6276-4993-bfeb-53cbbbba6f08/fail' \  -H 'Content-Type: application/json' \  -d '{  "code": "string",  "message": "string"}'
{  "data": {    "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",    "status": "succeeded"  },  "meta": {    "requestId": "string"  }}