# Get Payment Status

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

Product: [WhatsApp](https://devdocs.1spoc.com/docs/whatsapp.md)  
Version: [3.0](https://devdocs.1spoc.com/docs/whatsapp/3-0.md)  
Category: **Payments**  
Lifecycle: **active**

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

## Request overview

Full URL: `https://whatsapp.1spoc.com/v3/{phone_number_id}/payments/{payment_configuration}/{order-id}`

Method: `GET`

Content type: `No request body`

## Authentication

Send the credential in the request **header** using the field `apikey`.

> Keep real credentials on the server. The examples below use placeholders and never contain stored secrets.

## Parameters

### Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `phone_number_id` | string | Yes | Resource identifier for phone number id. |
| `payment_configuration` | string | Yes | Resource identifier for payment configuration. |
| `order-id` | string | Yes | Resource identifier for order id. |

### Query parameters

None.

### Request body fields

None.

## 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."
  }
]
```

## Generated integration examples

The following examples are generated from the published **GET /{phone_number_id}/payments/{payment_configuration}/{order-id}** contract and use placeholder credentials.

### cURL


```curl
curl --request GET 'https://whatsapp.1spoc.com/v3/{phone_number_id}/payments/{payment_configuration}/{order-id}' \
  --header 'apikey: <API_KEY>'
```

### JavaScript


```javascript
const response = await fetch('https://whatsapp.1spoc.com/v3/{phone_number_id}/payments/{payment_configuration}/{order-id}', {
  method: 'GET',
  headers: {
    "apikey": "<API_KEY>"
  },
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
```

### NodeJS


```node
const response = await fetch('https://whatsapp.1spoc.com/v3/{phone_number_id}/payments/{payment_configuration}/{order-id}', {
  method: 'GET',
  headers: {
    "apikey": "<API_KEY>"
  },
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
```

### Python


```python
import json
import requests

url = 'https://whatsapp.1spoc.com/v3/{phone_number_id}/payments/{payment_configuration}/{order-id}'
headers = {
  "apikey": "<API_KEY>"
}
response = requests.get(url, headers=headers)

response.raise_for_status()
print(response.json())
```

### Java


```java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var client = HttpClient.newHttpClient();
var request = HttpRequest.newBuilder(URI.create("https://whatsapp.1spoc.com/v3/{phone_number_id}/payments/{payment_configuration}/{order-id}"))
    .header("apikey", "<API_KEY>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
```

### PHP


```php
<?php
$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://whatsapp.1spoc.com/v3/{phone_number_id}/payments/{payment_configuration}/{order-id}',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => ["apikey: <API_KEY>"],
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;
```

### C#


```csharp
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("apikey", "<API_KEY>");
var response = await client.GetAsync("https://whatsapp.1spoc.com/v3/{phone_number_id}/payments/{payment_configuration}/{order-id}");
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

### Go


```go
package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    request, err := http.NewRequest("GET", "https://whatsapp.1spoc.com/v3/{phone_number_id}/payments/{payment_configuration}/{order-id}", nil)
    if err != nil { panic(err) }
    request.Header.Set("Accept", "application/json")
    request.Header.Set("apikey", "<API_KEY>")
    response, err := http.DefaultClient.Do(request)
    if err != nil { panic(err) }
    defer response.Body.Close()
    data, err := io.ReadAll(response.Body)
    if err != nil { panic(err) }
    if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
    fmt.Println(string(data))
}
```

## Related resources

- [Interactive documentation page](https://devdocs.1spoc.com/docs/whatsapp/3-0/get-payment-status)
- [Version documentation](https://devdocs.1spoc.com/docs/whatsapp/3-0.md)
- [OpenAPI JSON](https://devdocs.1spoc.com/docs/whatsapp/3-0/openapi.json)
- [OpenAPI YAML](https://devdocs.1spoc.com/docs/whatsapp/3-0/openapi.yaml)
- [Postman collection](https://devdocs.1spoc.com/postman/whatsapp/3-0/collection.json)
- [Postman environment](https://devdocs.1spoc.com/postman/whatsapp/3-0/environment.json)
- [MCP setup](https://devdocs.1spoc.com/mcp-setup)
- [AI documentation index](https://devdocs.1spoc.com/llms.txt)
- [Complete AI documentation](https://devdocs.1spoc.com/llms-full.txt)
- [Node.js SDK](https://devdocs.1spoc.com/sdk/whatsapp/3-0/node.zip)
- [Python SDK](https://devdocs.1spoc.com/sdk/whatsapp/3-0/python.zip)
- [Java SDK](https://devdocs.1spoc.com/sdk/whatsapp/3-0/java.zip)

## Guidance for AI assistants

Treat this document and its linked OpenAPI contract as the source of truth for **GET /{phone_number_id}/payments/{payment_configuration}/{order-id}**.

- Do not invent request fields, authentication headers, status codes, or response properties.
- Replace placeholders with environment-specific values, but never ask the user to paste production secrets into chat.
- Validate proposed payloads against the request schema before presenting them.
- Explain which values are required and identify assumptions clearly.
- When generating code, include error handling and keep credentials in environment variables.
- Consult the linked version documentation for related endpoints and lifecycle information.