Criar um pedido

post

https://api.pre.credix.finance/v2/orders

Cria um pedido enviando um payload JSON.

Formato dos erros

Erros de validação são serializados pelo filtro global da CrediPay em duas formas:

CredixErrorResponse (uma única validação): { message, code, context, timestamp, path, request_id }
CredixAggregateErrorResponse (várias validações falhando juntas): { message, code: "ORDER_VALIDATION_AGGREGATE_ERROR", errors: [{ message, code, context }], timestamp, path, request_id }

O campo code é estável e deve ser usado pelo seu sistema como chave de identificação do erro. A mensagem em message permanece em inglês para evitar quebras quando a tradução evoluir.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Dados do pedido.

batchId

string

Identificador opcional do lote ao qual o pedido pertence.

buyerTaxId

string

required

CNPJ do comprador.

sellerTaxId

string

required

CNPJ do vendedor.

metadata

object

required

Qualquer metadado que você queira anexar ao pedido. Tamanho serializado máximo: 102400 caracteres.

externalId

string

Defaults to REF-10230456

ID interno do pedido do vendedor.

installments

array of objects

required

Parcelas

installments*

items

array of objects

required

Itens do pedido.

items*

contactInformation

object

required

Informações de Contato do comprador.

shippingLocation

object

required

Endereço de Entrega.

processingMode

string

enum

required

Defaults to DDF

O modo de processamento da nota fiscal. 'DDF' significa que o vendedor faz o upload da nota fiscal para a plataforma antes da entrega das mercadorias. 'DDE' significa que o vendedor faz o upload da nota fiscal para a plataforma após a entrega das mercadorias.

Allowed:

financeContactGroupId

string

ID do grupo de contato do financeiro usado neste pedido. Necessário para validar, no servidor, se o contato passou pelo desafio quando a política exige. Sem ele, um cliente que nunca chamasse o endpoint de desafio criaria o pedido sem validação alguma.

Responses

201Operação bem-sucedida, pedido criado.

400Falha de validação do pedido. O corpo da resposta segue o formato CredixErrorResponse (erro único) ou CredixAggregateErrorResponse (várias validações falhando ao mesmo tempo, em errors[]).

401A autenticação foi aceita, mas a organização da API key não tem permissão para a operação solicitada.

403A operação não é permitida pela política da CrediPay ou pelo estado/perfil atual do recurso.

404Recurso referenciado pelo pedido não foi encontrado.

412Pré-condição do comprador ainda não atendida.