PT EN

Formas de pagamento

URL base: $CONSUMER_API

O objecto

tenant_idstring · obrigatório
availableboolean · obrigatório
methodsarray of string · opcional

Checkout methods a live payment connector can complete now, as the method codes the connectors declare. Absent when checkouts don't go through connectors; empty when none is live.

checkout_methodsarray of object · opcional

Methods the consumer can pay with in the app now; clients offer these and nothing else. Empty while payments are unavailable or no connector is live.

Mostrar atributos filhos
codestring · obrigatório
requires_phoneboolean · obrigatório
labelstring · opcional

The utility's own label for the collection channel of this method (the operator's label, or a neutral sample label in a test account); never derived from the code. Absent when no channel names it.

proof_methodsarray of string · opcional

The utility's enabled collection channels a consumer can pay through outside the app and then send a proof of payment for.

O objecto
{
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "available": true,
  "methods": [
    "method"
  ],
  "checkout_methods": [
    {
      "code": "COD-2026-000142",
      "requires_phone": true,
      "label": "label"
    }
  ],
  "proof_methods": [
    "proof method"
  ]
}

Obter as formas de pagamento disponíveis

Registos

GET /payment-availability

Whether each utility the consumer belongs to can take payments yet

Tells the client, per tenant where the caller has an account, whether payments are enabled and which checkout methods can be offered right now, each saying whether it needs the payer's phone. When checkouts go through payment connectors, only methods a connector heard from in the last 90 seconds declares operational are listed, so a client never offers a method the checkout would refuse. The response also lists the methods for which the tenant accepts proofs of payment.

Devolve

200 One row per tenant the consumer holds an account in

Mostrar atributos
dataarray of object · opcional
Mostrar atributos filhos
tenant_idstring · obrigatório
availableboolean · obrigatório
methodsarray of string · opcional

Checkout methods a live payment connector can complete now, as the method codes the connectors declare. Absent when checkouts don't go through connectors; empty when none is live.

checkout_methodsarray of object · opcional

Methods the consumer can pay with in the app now; clients offer these and nothing else. Empty while payments are unavailable or no connector is live.

Mostrar atributos filhos
codestring · obrigatório
requires_phoneboolean · obrigatório
labelstring · opcional

The utility's own label for the collection channel of this method (the operator's label, or a neutral sample label in a test account); never derived from the code. Absent when no channel names it.

proof_methodsarray of string · opcional

The utility's enabled collection channels a consumer can pay through outside the app and then send a proof of payment for.

curl -X GET "$CONSUMER_API/payment-availability" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "data": [
    {
      "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
      "available": true,
      "methods": [
        "method"
      ],
      "checkout_methods": [
        {
          "code": "COD-2026-000142",
          "requires_phone": true,
          "label": "label"
        }
      ],
      "proof_methods": [
        "proof method"
      ]
    }
  ]
}