Get Payment Status

get

https://api.in.kaleyra.io/v2/{sid}/whatsapp/{phone_number}/payments/{payment_config_id}/{reference_id}

The Get Payment Status API allows you to retrieve the status of a previously initiated transaction and returns all relevant transaction details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Note:
The payment_config_id and reference_id are same as that sent in the order_details message. For more information on the possible payment status Receive Payment via payment Gateway page.

Path Params

sid

string

required

Account SID (Security Identifier).

phone_number

string

required

The phone number (e.g., +918XXXXX5920) of the end user.

payment_config_id

string

required

Payment configuration for the order sent in order_details message.

reference_id

string

required

Unique reference ID for the order sent in order_details message.

Note: Unique identifier for the order or invoice provided by the business. It is case sensitive and cannot be an empty string and can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters.

The reference_id must be unique for each order_details message for a given business. If there is a need to send multiple order_details messages for the same order, it is recommended to include a sequence number in the reference_id (for example, “BM345A-12”) to ensure uniqueness.

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

400Bad Request

401Unauthorized

500Internal Server Error