Payment Details with External Reference

Get payment

GETapi-url/v1/partner/payments/external-reference/{externalReference}

Path parameters

externalReference*string

Header parameters

Response

200400403404

Returns payment for given external reference

Body

application/json

paymentId*string (uuid)

processingState*enum

CREATEDPROCESSINGSUCCESSFAILURE

createdOn*string (date-time)

transaction*nullable all of

initiationRequest*one of

objectobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('api-url/v1/partner/payments/external-reference/{externalReference}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400403404

{
  "paymentId": "123e4567-e89b-12d3-a456-426614174000",
  "processingState": "CREATED",
  "createdOn": "2025-02-05T07:38:07.643Z",
  "transaction": {
    "transactionId": "text",
    "uniqueToken": "123e4567-e89b-12d3-a456-426614174000",
    "origin": "TRANSFER",
    "state": "PENDING",
    "category": "GENERAL",
    "impactType": "NEUTRAL",
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "amount": 129,
    "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-02-05T07:38:07.643Z"
  },
  "initiationRequest": {
    "sourceAccountId": "123e4567-e89b-12d3-a456-426614174000",
    "destinationAccountId": "123e4567-e89b-12d3-a456-426614174000",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "amount": 129,
    "externalReference": "123e4567-e89b-12d3-a456-426614174000",
    "description": "Sent from Algbra"
  }
}