v1

latestOpenAPI 3.1.02026-07-136388308.2 KB

Payees

List transaction for a payee account

This endpoint retrieves the list of transactions and transaction information associated with a payee. You will need to enable PERM_BUSINESS_GET_FUNDING_SOURCE_TRANSACTIONS to use this endpoint.

get/v1/payees/{payeeId}/transactions

Path parameters

payeeIdinteger required

The unique ID of the payee.

Example:346748

Response

An array of payee transaction information

totalinteger

The total number of card transactions in the list.

dateRangeTointeger

milisecond timestamp of date range to value.

Example response

{
  "total": 1,
  "dateRangeTo": 1547744156603,
  "transactions": [
    {
      "txnId": 30157,
      "refId": 26774,
      "ican": 1951,
      "currency": {
        "code": "EUR",
        "description": "Euro"
      },
      "amountBeforeCharges": 5000,
      "amountAfterCharges": 5000,
      "balance": 8500,
      "myRef": "Transfer to main account",
      "yourRef": "From John Smith",
      "date": "2021-04-13T11:06:32.437Z",
      "paymentRequestPublicCode": "1abcdefg",
      "type": "WITHDRAWAL",
      "dateAcknowledged": "2021-04-13T11:06:32.437Z",
      "fxTradeDetails": {
        "buyCurrency": "GBP",
        "sellCurrency": "EUR",
        "fixedSide": "SELL",
        "buyAmount": 359,
        "sellAmount": 500,
        "rate4d": 7180,
        "provider": "TCC"
      },
      "batchItemDetails": {
        "batchPublicUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
        "batchItemPublicUuid": "F2AF3F2B-4406-4199-B249-B354F2CC6019",
        "batchName": "Payroll 2022-11",
        "jobNumber": "2018-01-PR"
      },
      "directDebitDetails": {
        "directDebitUuid": "42de0705-e3f1-44fa-8c41-79973eb80eb2",
        "mandateUUid": "f171b143-e3eb-47de-85a6-1c1f1108c701",
        "originatorReference": "VODA-123456",
        "originatorName": "Vodafone PLC",
        "originatorAlias": "Three",
        "directDebitReference": "VODA-ABC453-1",
        "originatorLogoUrlSmall": "https://s3-eu-west-1.amazonaws.com/live-fire-assets/prod/49dc9a01-8261-4d98-bebf-c3842c2d3c5d-small.png",
        "originatorLogoUrlLarge": "https://s3-eu-west-1.amazonaws.com/live-fire-assets/prod/49dc9a01-8261-4d98-bebf-c3842c2d3c5d-small.png",
        "mandateReference": "CRZ-102190123",
        "mandateUuid": "28d627c3-1889-44c8-ae59-6f6b20239260"
      },
      "proprietarySchemeDetails": [
        {
          "type": "SCT",
          "data": "remittanceInfoUnstructured^FIRE440286865OD1|instructionId^O223151336499079"
        }
      ],
      "relatedParty": {
        "account": {
          "id": 42,
          "alias": "Main Account",
          "bic": "CPAYIE2D",
          "iban": "IE54CPAY99119911111111",
          "nsc": "232221",
          "accountNumber": "11111111"
        }
      },
      "eventUuid": "42de0705-e3f1-44fa-8c41-79973eb80eb2"
    }
  ]
}