Description and Details
This API is used to initiate a payment transaction. It allows third-party providers (TPPs) or internal services to submit a payment request on behalf of a user or system. Once initiated, the payment is queued for processing based on the request details such as payer, payee, amount, and payment type.
Endpoint
https://api-dev-isolution.xyz/paymentinitiation
Verb Method
POST
Headers Request Parameters
| Header Key | Value | Description |
|---|---|---|
| Content-Type | application/json | Specifies the format of the request body |
| Accept | application/json | Indicates expected response format |
| Authorization | Bearer {token} | Required – Valid access token |
Body Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| payerAccount | string | Yes | Source account number or ID |
| payeeAccount | string | Yes | Destination account number or ID |
| amount | string | Yes | Amount to be transferred |
| currency | string | Yes | Currency code (e.g., USD, PKR) |
| reference | string | No | Reference or note for the payment |
| paymentDate | string | Yes | Scheduled date of payment (ISO format) |
| paymentType | string | Yes | Type of payment (e.g., IMMEDIATE) |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| paymentId | string | Unique identifier for the payment |
| status | string | Status of the payment (e.g., PENDING) |
| message | string | Description or confirmation message |
HTTP Codes
| Code | Meaning |
|---|---|
| 200 | OK – Payment initiated successfully |
| 400 | Bad Request – Invalid or missing parameters |
| 401 | Unauthorized – Invalid or missing token |
| 403 | Forbidden – Permission denied |
| 500 | Internal Server Error |