Partner Banking Docs
HomeStatus
  • Introduction
  • Getting Started
    • Partner Onboarding
    • Security
    • Authentication
    • Payload Signing
    • API Hosts
  • Concepts
    • API Connectivity Test
    • Accounts
      • Primary Accounts
      • Virtual Accounts
      • Getting Accounts
      • Balances Explained
    • Payments
      • Payment Simulation
      • Inbound Payments
      • Internal Payments
      • Counterparty Validation
      • Outbound Payments
      • Payment Details
        • Payment Details with ID
        • Payment Details with External Reference
    • Transactions
      • Activity Feed
    • Webhooks
      • Webhook Guidelines
      • Supported Events
      • Testing Webhooks
  • Full Specification
  • Return Home
Powered by GitBook
On this page

Was this helpful?

  1. Concepts
  2. Payments
  3. Payment Details

Payment Details with ID

PreviousPayment DetailsNextPayment Details with External Reference

Last updated 5 months ago

Was this helpful?

Get payment

get
Path parameters
paymentIdstringRequired
Header parameters
authorizationstringOptional

Authorization header containing your API Token

x-alg-noncestringOptional

Nonce used to generate the payload signature

x-alg-signaturestringOptional

Payload signature

datestringOptional

Date of the request un UTC/GMT

Responses
200
Returns payment for given payment id
application/json
400
Input validation error
application/json
403
Forbidden
application/json
404
Payment not found
application/json
get
GET /v1/partner/payments/{paymentId} HTTP/1.1
Host: api-url
Accept: */*
{
  "paymentId": "123e4567-e89b-12d3-a456-426614174000",
  "processingState": "CREATED",
  "createdOn": "2025-05-19T14:26:30.739Z",
  "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-05-19T14:26:30.739Z"
  },
  "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"
  }
}