Get Brazil payment status

Get Brazil payment and transaction status.

get/whatsapp/1/senders/{sender}/payments/br/{paymentId}

Request

Base URL
https://api.infobip.com (the document declares no server; this is the origin it was published from)
Auth
- OAuth 2
  Client credentials
  Token URL: https://api.infobip.com/auth/1/oauth2/token
- or API key in header Authorization
- or API key in header Authorization
- or HTTP basic

Path parameters

senderstring required

Registered WhatsApp sender number. Must be in international format.

paymentIdstring required

Unique identifier of the payment.

Response

Payment successfully retrieved.

referenceIdstring required

Unique identifier generated by the payment service provider.

paymentIdstring

Unique identifier of the payment.

Status of the payment.

currency'INR' | 'BRL' | 'UNKNOWN' required

Currency of the payment.

totalAmountValueinteger required

Value of the payment amount.

totalAmountOffsetinteger required

Offset of the payment amount.

callbackDataobject

Custom parameters corresponding to the transaction. Available only for PayU UPI Payments and Razorpay.

Example response

{
  "referenceId": "72123248136",
  "paymentId": "16085194825",
  "paymentStatus": "PENDING",
  "currency": "INR",
  "totalAmountValue": 21000,
  "totalAmountOffset": 100,
  "transactions": [
    {
      "id": "27194245144",
      "type": "UPI",
      "status": "SUCCESS"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.