# Get Payment Status

**GET** `/{phone_number_id}/payments/{payment_configuration}/{order-id}`

Product: [WhatsApp](https://devdocs.pinnacle.in/docs/whatsapp.md)  
Version: [3.0](https://devdocs.pinnacle.in/docs/whatsapp/3-0.md)

This API is used to get the payment status for the given order id using phone number id.

## Request

URL: `https://partnersv1.pinbot.ai/v3/{phone_number_id}/payments/{payment_configuration}/{order-id}`

Authentication location: `header`

Authentication name: `apikey`

### Request schema


```json
{
  "type": "object",
  "properties": {}
}
```

### Request example


```json
{}
```

## Response schema


```json
{
  "type": "object",
  "properties": {
    "payments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "object",
            "properties": {
              "value": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              }
            }
          },
          "status": {
            "type": "string"
          },
          "currency": {
            "type": "string"
          },
          "reference_id": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

## Response examples


```json
{
  "200": {
    "payments": [
      {
        "amount": {
          "value": 100,
          "offset": 100
        },
        "status": "PENDING",
        "currency": "INR",
        "reference_id": "order-id"
      }
    ]
  }
}
```

## Status codes


```json
[
  {
    "code": 200,
    "description": "The request was successful."
  },
  {
    "code": 400,
    "description": "Bad request or invalid parameters."
  },
  {
    "code": 401,
    "description": "API key is missing or invalid."
  },
  {
    "code": 403,
    "description": "The request is not authorized for this resource."
  },
  {
    "code": 404,
    "description": "The requested resource was not found."
  },
  {
    "code": 500,
    "description": "The server encountered an error."
  }
]
```