APG PayAPG Paydocs

Transactions

Get transfer

GET/transfers/{transferId}
Request
GEThttps://api.tst.au.apgpay.dev/transfers/{transferId}
curl -X GET https://api.tst.au.apgpay.dev/transfers/{transferId} \
  -H "Authorization: Bearer $API_KEY"

Return the transfer record for a transaction: every movement out of it, and how much is left to move. The identifier is the transaction's.

Permissions

Required permission
transactions:query

Requires the `query` action on `transactions` for the supplied runtime context

Path parameters

transferIdstring
required

Responses

The response is a tagged shape: type is always "TtfrViewAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "TtfrViewAttributes"
transferIdTranIdrequired

The transaction whose funds these movements come out of. This is also the record's identifier.

Example tran_9f2Kd8QpLzXw

merchantIdMchtIdrequired

The merchant that took the payment, and the source of every movement here.

Example mcht_9f2Kd8QpLzXw

marketplaceIdMktpIdrequired

The marketplace the transfers are made in. Inferred from the credential, not supplied.

Example mktp_9f2Kd8QpLzXw

enterpriseIdEntIdrequired

Identifier of an enterprise.

Example ent_9f2Kd8QpLzXw

stateTtfrStaterequired

Whether a movement is in flight. A caller seeing Transferring should retry rather than treat it as final.

AvailableTransferringUnknown

A transaction's total and what has been moved out of it. All in the single currency given here.

Every transfer and reversal, oldest first. Append-only, a reversal is a negative movement, not an edit.

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "type": "TtfrViewAttributes",
  "transferId": "tran_9f2Kd8QpLzXw",
  "merchantId": "mcht_9f2Kd8QpLzXw",
  "marketplaceId": "mktp_9f2Kd8QpLzXw",
  "enterpriseId": "ent_9f2Kd8QpLzXw",
  "state": "Available",
  "amounts": {
    "type": "TtfrAmountsAttributes",
    "currency": "AUD",
    "transactionAmount": 1250,
    "transferred": 1250,
    "transferable": 1250,
    "levied": 1250,
    "surcharged": 1250
  },
  "movements": [
    {
      "type": "TtfrMovementAttributes",
      "toMerchantId": "mcht_9f2Kd8QpLzXw",
      "idempotencyKey": "string",
      "transferred": 1250,
      "surcharged": 1250,
      "levy": 1250,
      "metadata": {
        "yourKey": "string"
      },
      "createdAt": "2026-08-19T04:21:07Z"
    }
  ],
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses