Skip to main content

PagedModelPaymentRequestPayment

content object[]
  • Array [
    • iduuid

    Unique identifier for the payment

    Example: 123e4567-e89b-12d3-a456-426614174000
    referencestring

    Reference for the payment

    Example: REF123
    statusstring

    Status of the payment

    Possible values: [CREATED, PENDING, RECEIVED, COMPLETE, FAILED, REVERSED]

    Example: PENDING
    paymentSymbolstring

    Currency in which the payment is made

    Example: AED
    paymentAmountnumber

    Amount to be paid

    Example: 100
    receivingCurrencystring

    Currency in which the payment is received

    Example: GBP
    receivingAmountnumber

    Amount received after conversion

    Example: 75
    methodstring

    Payment method used for the transaction

    Possible values: [CARD, BANK_TRANSFER, CRYPTO]

    Example: BANK_TRANSFER
    accountIduuid

    Unique identifier for the account

    Example: 123e4567-e89b-12d3-a456-426614174004
    payerIduuid

    Unique identifier for the payer

    Example: 123e4567-e89b-12d3-a456-426614174001
    paymentRequestIduuid

    Unique identifier for the payment request

    Example: 123e4567-e89b-12d3-a456-426614174002
    createdAtdate-time

    Timestamp when the payment was created

    Example: 2023-10-01T12:00:00Z
    details object

    Details depending on payment method

    type

    Details depending on payment method

    Possible values: [PaymentRequestCardPayment, PaymentRequestCryptoPayment, PaymentRequestBankTransferPayment]

    issuerstring

    Card issuer

    issuerCountrystring

    Country of the card issuer

    schemestring

    Card scheme

    Example: VISA
    cardTypestring

    Card type

    Example: CREDIT
    last4string
    payout object
    beneficiaryIduuid
    referencestring
    transactionReferencestring
    purposeOfPaymentstring

    Possible values: [COMPUTER_SERVICES, FAMILY_SUPPORT, EDUCATION, MEDICAL_TREATMENT, MAINTENANCE_EXPENSES, TRAVEL, SMALL_VALUE_REMITTANCE, CONSTRUCTION_EXPENSES, HOTEL_ACCOMMODATION, ADVERTISING_EXPENSES, ADVISORY_FEES, BUSINESS_INSURANCE, INSURANCE_CLAIMS, DELIVERY_FEES, EXPORTED_GOODS, SERVICE_CHARGES, LOAN_PAYMENT, OFFICE_EXPENSES, PROPERTY_PURCHASE, PROPERTY_RENTAL, ROYALTY_FEES, SHARES_INVESTMENT, FUND_INVESTMENT, TAX_PAYMENT, TRANSPORTATION_FEES, UTILITY_BILLS, PERSONAL_TRANSFER, SALARY_PAYMENT, INFLUENCER_PAYMENT, DIVIDEND_PAYMENT, REWARD_PAYMENT, OTHER_FEES, OTHER]

    amountnumber
    currencystring
    statusstring

    Status of a payment payout during its lifecycle.

    Possible values: [PENDING_APPROVAL, INITIATED, PAID, FAILED]

  • ]
    • page object
    sizeint64
    numberint64
    totalElementsint64
    totalPagesint64
    PagedModelPaymentRequestPayment
    {
      "content": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "reference": "REF123",
          "status": "PENDING",
          "paymentSymbol": "AED",
          "paymentAmount": 100,
          "receivingCurrency": "GBP",
          "receivingAmount": 75,
          "method": "BANK_TRANSFER",
          "accountId": "123e4567-e89b-12d3-a456-426614174004",
          "payerId": "123e4567-e89b-12d3-a456-426614174001",
          "paymentRequestId": "123e4567-e89b-12d3-a456-426614174002",
          "createdAt": "2023-10-01T12:00:00Z",
          "details": {
            "issuer": "string",
            "issuerCountry": "string",
            "scheme": "VISA",
            "cardType": "CREDIT",
            "last4": "string"
          },
          "payout": {
            "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "reference": "string",
            "transactionReference": "string",
            "purposeOfPayment": "COMPUTER_SERVICES",
            "amount": 0,
            "currency": "string",
            "status": "PENDING_APPROVAL"
          }
        }
      ],
      "page": {
        "size": 0,
        "number": 0,
        "totalElements": 0,
        "totalPages": 0
      }
    }