v1

latestOpenAPI 3.0.02026-07-2411724301.7 KB

Payments

Get Payment Status

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

get/v2/{sid}/whatsapp/{phone_number}/payments/{payment_config_id}/{reference_id}

Path parameters

sidstring required

Account SID (Security Identifier).

phone_numberstring required

Example:+91863XXXXXXX

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

payment_config_idstring required

Payment configuration for the order sent in order_details message.

reference_idstring 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.

Response

Successful response

codestring required

messagestring required

errorobject