Get a Payment

Developing

Cloud Mock

https://mock.apidog.com/m1/828215-0-default

GET

/payments/{payment_id}

OperationId:get_payment_request_by_id

Returns the payment matching the Id provided.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://{domain}.auth.{region}.amazoncognito.com

Scopes:

payments:read-Can read payment requests.

Path Params

Responses

🟢200Success

application/json

Body

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://mock.apidog.com/m1/828215-0-default/payments/' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "payment_record": {
        "id": "6e9d5ac0-9ac1-45d3-a971-b2a26c44223f",
        "mandate_id": "1720151b-9a21-40eb-b828-c52144a11e28",
        "due_date": "2026-05-04",
        "requested_amount": 1988,
        "currency": "FKP",
        "status": "PendingSubmission",
        "actual_amount": 0,
        "metadata": null,
        "expected_payments": [
            {
                "expected_pay_date": "2026-04-26",
                "amount": 663,
                "supply_method": "Payroll",
                "status": "PendingSubmission"
            },
            {
                "expected_pay_date": "2026-05-03",
                "amount": 662,
                "supply_method": "Payroll",
                "status": "PendingSubmission"
            },
            {
                "expected_pay_date": "2027-01-20",
                "amount": 662,
                "supply_method": "Payroll",
                "status": "PendingSubmission"
            }
        ]
    }
}

Cancel an existing payment request

Get many Payments