Show Payment details
Guide to integrating with our payment API
Show Payment Details Endpoint
This endpoint allows you to retrieve the details of a specific payment by providing the order number of the transaction. It returns the payment details, including the amount, order number, order ID, status, form URL, confirmation status, and update timestamp, plus a ready-to-show display block.
GET /api/payment/show
Headers
| Key | Value | Required |
|---|---|---|
| Accept | application/json | Yes |
| Content-Type | application/json | Yes |
| x-app-key | YOUR_APP_KEY | Yes |
| x-app-secret | YOUR_SECRET_KEY | Yes |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| order_number | string | Yes | The order number of transaction to retrieve |
Example Usage in Different Languages
Response
The display block
attributes.display holds what your page shows the payer. Show it as it is: no condition on your side.
| Key | Type | Value |
|---|---|---|
outcome | string | success, pending or failed |
message | string or null | The headline to show the payer |
rows | array | Ordered label and value pairs, printed as label: value |
outcome
status | outcome |
|---|---|
paid | success |
initiated, processing, pending | pending |
| any other value | failed |
message is params.respCode_desc when filled, otherwise action_code_description when filled, otherwise null. It is the return message the SATIM success and failed pages must show.
rows come in this order. A row with no value is left out.
label | value | Format |
|---|---|---|
ID de transaction | order_number | As stored |
Numéro de commande | order_id | As stored |
Numéro d'autorisation | approval_code, otherwise auth_code | As stored |
Montant | amount | 1 500,00 DZD |
Carte | pan | As stored |
Date | created_at | dd/mm/yyyy HH:mm, Algiers time |
Labels are in French and do not change. Every other attribute stays as before.