Partner Banking Docs

Activity Feed

PreviousTransactions NextWebhooks

Last updated 24 days ago

Get transaction

GETapi-url/v1/partner/transactions/{transactionId}

Path parameters

transactionId*string

Header parameters

Response

Transaction detail

Body

id*string (uuid)

origin*enum

TRANSFER

state*enum

PENDINGCOMPLETEDCANCELLEDFAILED

category*enum

GENERALSHOPPINGTRANSFERSEATING_OUTDONATIONSFAMILYCASHENTERTAINMENTEXPENSESGIFTSGROCERIESHOLIDAYSINVESTMENTSPERSONAL_CARESALARYSAVINGSSERVICESTRANSPORTUTILITIESCASHBACK_REWARDSREFERRAL_REWARDS

impactType*enum

NEUTRALDEBITCREDIT

customerId*string (uuid)

amount*number

currencyCode*enum

AFNEURALLDZDUSDAOAXCDARSAMDAWGAUDAZNBSDBHDBDTBBDBYNBZDXOFBMDINRBTNBOBBOVBAMBWPNOKBRLBNDBGNBIFCVEKHRXAFCADKYDCLPCLFCNYCOPCOUKMFCDFNZDCRCHRKCUPCUCANGCZKDKKDJFDOPEGPSVCERNSZLETBFKPFJDXPFGMDGELGHSGIPGTQGBPGNFGYDHTGHNLHKDHUFISKIDRXDRIRRIQDILSJMDJPYJODKZTKESKPWKRWKWDKGSLAKLBPLSLZARLRDLYDCHFMOPMKDMGAMWKMYRMVRMRUMURXUAMXNMXVMDLMNTMADMZNMMKNADNPRNIONGNOMRPKRPABPGKPYGPENPHPPLNQARRONRUBRWFWSTSTNSARRSDSCRSLLSGDXSUSBDSOSSSPLKRSDGSRDSEKCHECHWSYPTWDTJSTHBTOPTTDTNDTRYTMTUGXUAHAEDUSNUYUUYIUYWUZSVUVVESVNDYERZMWZWLXBAXBBXBCXBDXTSXXXXAUXPDXPTXAGAFAFIMADPESPFRFAOKAORRURATSAYMAZMBYBBYRBECBEFBELBADBRBBRRBGJCYPCSKECSECVGQEEEKXEUGEKDDMDEMGHCGHPGRDGWEITLIEPLVLZALLTLLUCLUFLULMGFMLFMTLMROMZENLGPLZPTEROKSTDCSDSKKSITRHDESAESBSDDSRGTJRTPETRLTMMUAKUSSVEBVEFYUDZRNZMKZWNZWR

description*string

exchangeRate*string

exchangeCurrencyCode*enum

AFNEURALLDZDUSDAOAXCDARSAMDAWGAUDAZNBSDBHDBDTBBDBYNBZDXOFBMDINRBTNBOBBOVBAMBWPNOKBRLBNDBGNBIFCVEKHRXAFCADKYDCLPCLFCNYCOPCOUKMFCDFNZDCRCHRKCUPCUCANGCZKDKKDJFDOPEGPSVCERNSZLETBFKPFJDXPFGMDGELGHSGIPGTQGBPGNFGYDHTGHNLHKDHUFISKIDRXDRIRRIQDILSJMDJPYJODKZTKESKPWKRWKWDKGSLAKLBPLSLZARLRDLYDCHFMOPMKDMGAMWKMYRMVRMRUMURXUAMXNMXVMDLMNTMADMZNMMKNADNPRNIONGNOMRPKRPABPGKPYGPENPHPPLNQARRONRUBRWFWSTSTNSARRSDSCRSLLSGDXSUSBDSOSSSPLKRSDGSRDSEKCHECHWSYPTWDTJSTHBTOPTTDTNDTRYTMTUGXUAHAEDUSNUYUUYIUYWUZSVUVVESVNDYERZMWZWLXBAXBBXBCXBDXTSXXXXAUXPDXPTXAGAFAFIMADPESPFRFAOKAORRURATSAYMAZMBYBBYRBECBEFBELBADBRBBRRBGJCYPCSKECSECVGQEEEKXEUGEKDDMDEMGHCGHPGRDGWEITLIEPLVLZALLTLLUCLUFLULMGFMLFMTLMROMZENLGPLZPTEROKSTDCSDSKKSITRHDESAESBSDDSRGTJRTPETRLTMMUAKUSSVEBVEFYUDZRNZMKZWNZWR

sourceCounterparty*PartnerPaymentCounterpartyPayload (object)

destinationCounterparty*PartnerPaymentCounterpartyPayload (object)

transactionDate*string (date-time)

Request

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "origin": "TRANSFER",
  "state": "PENDING",
  "category": "GENERAL",
  "impactType": "NEUTRAL",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 0,
  "currencyCode": "AFN",
  "description": "text",
  "exchangeRate": "text",
  "exchangeCurrencyCode": "AFN",
  "sourceCounterparty": {
    "type": "PERSONAL",
    "details": {
      "firstName": "John",
      "lastName": "Doe"
    },
    "accountCurrency": "GBP",
    "accountReferenceType": "UK_ACCOUNT",
    "accountReference": {
      "type": "UK_ACCOUNT",
      "sortCode": "010102",
      "accountNumber": "12345678"
    }
  },
  "destinationCounterparty": {
    "type": "PERSONAL",
    "details": {
      "firstName": "John",
      "lastName": "Doe"
    },
    "accountCurrency": "GBP",
    "accountReferenceType": "UK_ACCOUNT",
    "accountReference": {
      "type": "UK_ACCOUNT",
      "sortCode": "010102",
      "accountNumber": "12345678"
    }
  },
  "transactionDate": "2025-01-04T23:28:09.367Z"
}

const response = await fetch('api-url/v1/partner/transactions?accountIds=text&fromDate=text&toDate=text&origins=text&states=text&page=1&limit=10', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "origin": "TRANSFER",
      "state": "PENDING",
      "category": "GENERAL",
      "impactType": "NEUTRAL",
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "amount": 0,
      "currencyCode": "AFN",
      "description": "text",
      "exchangeRate": "text",
      "exchangeCurrencyCode": "AFN",
      "sourceCounterparty": {
        "type": "PERSONAL",
        "details": {
          "firstName": "John",
          "lastName": "Doe"
        },
        "accountCurrency": "GBP",
        "accountReferenceType": "UK_ACCOUNT",
        "accountReference": {
          "type": "UK_ACCOUNT",
          "sortCode": "010102",
          "accountNumber": "12345678"
        }
      },
      "destinationCounterparty": {
        "type": "PERSONAL",
        "details": {
          "firstName": "John",
          "lastName": "Doe"
        },
        "accountCurrency": "GBP",
        "accountReferenceType": "UK_ACCOUNT",
        "accountReference": {
          "type": "UK_ACCOUNT",
          "sortCode": "010102",
          "accountNumber": "12345678"
        }
      },
      "transactionDate": "2025-01-04T23:28:09.367Z"
    }
  ],
  "meta": {
    "totalItems": 100,
    "itemCount": 10,
    "itemsPerPage": 10,
    "totalPages": 10
  }
}