Cobranças

Cobrar, ler, acompanhar. O recurso central é a operação; o percurso nominal é o checkout alojado.

Criar uma cobrança

POST /v1/payments

Campo	Obrigatório	Descrição
asset_id	sim	O activo, pelo seu identificador (GET /v1/assets)
amount_minor	sim	Cadeia, em unidades menores ("500000" num activo sem casas decimais são 500 000)
country	sim	País da operação (ISO 3166-1 alfa-2)
platform_id	sim	A plataforma de cobrança (GET /v1/corridors)
platform_account_handle	—	A subconta a creditar. Vazio = a conta primária do corredor
rail	—	Força um rail preciso em vez de deixar o encaminhamento escolher
payer	—	{ "name", "phone", "email", "country" }
client_ref	—	A sua referência, devolvida nas leituras e nos webhooks
description	—	Texto livre
expires_in_seconds	—	Duração de validade da intenção de pagamento

A resposta é uma operação no estado initiated, com o necessário para fazer o cliente pagar:

{
  "id": "op_01J8Z9K2QW",
  "ref": "NP-...",
  "client_ref": "encomenda-1042",
  "kind": "payin",
  "status": "initiated",
  "asset_id": 1,
  "amount_minor": "500000",
  "fee_minor": "...",
  "net_minor": "...",
  "payment_url": "https://pay.neo-pays.com/...",
  "is_test": true
}

rail força, não sugere. Omita-o e o encaminhamento escolhe o melhor rail aberto; nomeie-o e um rail indisponível faz a criação falhar em vez de passar para outro.

Ler e listar

GET /v1/payments/{id}   — uma operação
GET /v1/payments        — lista paginada (page, per_page)

{id} aceita o identificador interno, a referência da operação, ou a sua própria client_ref.

A leitura é local: nada é pedido ao rail. Os contactos do pagador estão aí mascarados, porque o modelo de leitura nunca guarda os originais — já a resposta da criação devolve-lhe o que acabou de enviar.

As listas são servidas por uma réplica de leitura: nenhum relatório pode abrandar um pagamento.

As outras famílias

O mesmo objecto, com o seu próprio nome: /v1/payouts, /v1/refunds, /v1/transfers, /v1/rebalances. GET /v1/payouts/{id} e os seus semelhantes devolvem a mesma vista mascarada, com o mesmo controlo de propriedade.