Get payment

GET/payment

Get Payment order

To get payment order data, you should make a request to this endpoint: GET /payment.

Required Parameters

  • Name
    paymentOrderId
    Type
    string
    Description

    The unique identifier (uuid) of the payment order to retrieve.

You should include this parameter in the JWT payload alongside other parameters required for authentication.

Payload example in JSON

{
  "jti": "9f3c2a1b7d9e4c51", 
  "exp": 1718112345,
  "accessKey": "your-access-key",
  "paymentOrderId": "02b394ce-9569-4bfb-a033-d0314ae94806",
}

Implementation Examples

const jwt = require('jsonwebtoken');
const crypto = require('crypto');

const payload = {
    jti: crypto.randomBytes(8).toString('hex'),
    exp: Math.floor(Date.now() / 1000) + (5 * 60), // Token expires in 5 minutes
    accessKey: 'your-access-key',
    paymentOrderId: '02b394ce-9569-4bfb-a033-d0314ae94806'
};

const token = jwt.sign(payload, secret, { algorithm: 'HS256' });

Refer this guide on how to include token to request.

Response Format

The API returns a JSON response containing the payment details:

{
    "paymentId": "02b394ce-9569-4bfb-a033-d0314ae94806",
    "orderReference": "Example-REFERENCE",
    "amount": 12.34,
    "currency": "EUR",
    "status": "success"
}

Payment Status Values

  • Name
    pending
    Description

    Payment has been initiated but not yet completed.

  • Name
    processing
    Description

    Payment is being processed

  • Name
    completed
    Description

    Payment has been successfully processed.

  • Name
    canceled
    Description

    Payment was canceled by the client or bank.

  • Name
    expired
    Description

    Payment session has expired without completion.

  • Name
    failed
    Description

    Payment failed due to technical issues.

Important Note

The payment status can change over time. For real-time updates about payment status changes, implement webhook handling as described in the Webhooks documentation.