Skip to main content
Todo response de GET /{resource}/{id} e todo payload de webhook usam este envelope. O objeto attributes varia por processo — consulte as páginas de cada recurso para as tabelas completas de campos.

​
Estrutura

​
Campos

A mecânica interna do processo — o componente, seu estado bruto e o nome do template — deliberadamente não faz parte deste contrato e nunca aparece em um response. Conduza sua integração por status e substatus.
process é um código de estágio, não um tipo de recurso. Ele diz onde a transação está, não que tipo ela é, e alguns valores — success.completed, por exemplo — são compartilhados entre produtos. Não use esse campo para decidir como interpretar attributes. Use o endpoint que você chamou e, quando um mesmo endpoint pode devolver mais de uma forma, ramifique por quais chaves de atributo estão presentes.

​
Lendo o envelope corretamente

Os quatro objetos de rótulo estão sempre presentes. Quando um estado não tem rótulo registrado, status, substatus, message e error_message voltam como {"en": "", "pt": "", "es": ""} — presentes e vazios, não ausentes. Trate string vazia como “sem informação”; não espere que a chave esteja faltando. attributes é sempre um objeto. Quando um processo não tem schema de atributos publicado, você recebe {}, não um campo ausente nem null. Atributo de valor vazio é omitido de attributes. Chave ausente significa “ainda não preenchido” — é assim que se distingue “ainda não aconteceu” de “aconteceu com valor zero”. Verifique a presença da chave, não se o valor é falsy.

​
version é um rótulo, não a versão da API

O campo carrega um literal por rota, e as rotas de ramp ainda emitem "v1": Todas são rotas /v2/ sobre o mesmo contrato. O valor é um rótulo herdado — não ramifique por ele.

​
Responses de lista

Todos os endpoints de lista (GET /v2/crossramp_checkouts, GET /v2/onramps, etc.) devolvem os mesmos objetos de transação dentro de um array results, envolvidos em um envelope de paginação:
total é a contagem de correspondências sem paginação aplicada, então serve para percorrer o conjunto inteiro. results nunca é null — página vazia é []. Os itens dentro de results carregam todos os campos acima, exceto version. Listas são sempre ordenadas por data de criação, da mais recente para a mais antiga. A ordenação não é configurável.

​
Webhooks

Webhooks entregam o mesmo objeto JSON do endpoint GET /{resource}/{id} correspondente. Configure a URL do webhook por transação no momento da criação, ou por template no dashboard.