OZozav
Transfers

List transfers

Lists transfers, newest first, with the standard cursor pagination. Filter by customer_id and/or status (a TransferStatus value). Returns a Page of Transfer. BRL/Pix paths create real transfer records; combinations whose settlement rails are not enabled still fail closed before a transfer is persisted.

get/transfers

Request

  • Base URL
    https://developers.ozav.io/v2
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Query parameters

limitinteger

Page size.

starting_afterstring

Opaque cursor returned as next_cursor on the previous page.

customer_idstring

Filter to a single customer by its opaque ozav_cus_ id.

status'awaiting_payment' | 'payment_confirmed' | 'converting' | 'payout_initiated' | 'completed' | 'failed' | 'cancelled' | 'expired' | 'needs_review' | 'awaiting_approval'

Canonical transfer state machine. A successful FX transfer walks awaiting_payment → payment_confirmed → converting → payout_initiated → completed; the remaining states are terminal failures or attention states.

ValueMeaning
awaiting_paymentTransfer created; awaiting the customer's inbound payment.
payment_confirmedThe inbound payment has been confirmed.
convertingFunds are in flight and the FX conversion is underway (not yet confirmed).
payout_initiatedThe payout to the destination has been initiated.
completedTerminal success - funds delivered to the destination.
failedTerminal failure - no funds delivered.
cancelledTerminal - the transfer was cancelled.
expiredTerminal - the transfer expired before completing.
needs_reviewStuck and needs attention (e.g. underfunded, returned, in review); not terminal.
awaiting_approvalNot returned: no transfer waits on approver keys.

Filter transfers by their current TransferStatus.

Response

Paginated transfers.

has_moreboolean required

True when more results exist beyond this page - keep paging with starting_after.

next_cursorstring nullable

Opaque cursor for the next page; pass it as starting_after. Null on the last page.

Example response

{
  "data": [
    {
      "amounts": {
        "source": {
          "amount": "1250.00"
        },
        "target": {
          "amount": "1250.00"
        }
      },
      "travel_rule": {
        "originator": {
          "identity_documents": [
            {
              "type": "cpf",
              "number": "11144477735",
              "issuing_country": "BR"
            }
          ],
          "address": {
            "country": "BR"
          }
        },
        "beneficiary": {
          "identity_documents": [
            {
              "type": "cpf",
              "number": "11144477735",
              "issuing_country": "BR"
            }
          ],
          "address": {
            "country": "BR"
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.