Capturar pedido

Endpoint que permite enviar um arquivo XML de Nota Fiscal para um pedido existente. Assim que o arquivo XML é aceito, um job é disparado para realizar validações e capturar o pedido — parte das validações roda de forma assíncrona. Falhas síncronas (estado do pedido, lock em andamento, parsing do XML, validações internas de elegibilidade/política) retornam imediatamente nesta resposta.

Formato dos erros

Erros seguem o mesmo formato de POST /v2/orders: CredixErrorResponse (uma falha) ou CredixAggregateErrorResponse (várias falhas, em errors[]). O code é estável e deve ser usado para o tratamento programático.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID interno de pedido da CrediPay. Formato UUID v4.

Query Params
boolean

Indica se esta captura deve ser tratada como captura parcial.

Body Params

Arquivo XML de Nota Fiscal. Precisa ter sido processado e aprovado pela SEFAZ (XMLs de rascunho não são permitidos).

file
required
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json