Refresh Payment Status

curl --request POST \
  --url https://meet.briq.tz/api/v1/payments/{id}/refresh \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "code": 123,
  "message": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reference": "<string>",
    "external_id": "<string>",
    "amount": 123,
    "margin_amount": 123,
    "total_amount": 123,
    "currency": "<string>",
    "phone": "<string>",
    "network": "<string>",
    "payment_url": "<string>",
    "qr_code": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  },
  "meta": {}
}

POST

api

payments

{id}

refresh

Refresh Payment Status

curl --request POST \
  --url https://meet.briq.tz/api/v1/payments/{id}/refresh \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "code": 123,
  "message": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reference": "<string>",
    "external_id": "<string>",
    "amount": 123,
    "margin_amount": 123,
    "total_amount": 123,
    "currency": "<string>",
    "phone": "<string>",
    "network": "<string>",
    "payment_url": "<string>",
    "qr_code": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  },
  "meta": {}
}

Performs a live status check and updates the payment. Triggers webhooks/callbacks if the status changed. Use sparingly — each call performs a live upstream check and returns 502 PROVIDER_ERROR when that check is temporarily unavailable. For routine polling prefer GET /api/v1/payments/; PayGrid also refreshes pending payments automatically.

Authorizations

Authorization

string

header

required

API key obtained from the merchant dashboard. When using the 'Try It' feature, enter only the key—the 'Bearer ' prefix is added automatically. For direct API calls, the 'Authorization: Bearer ' format is mandatory.

Path Parameters

string<uuid>

required

Response

Payment status refreshed

Standard success envelope wrapping all API responses.

status

enum<string>

Available options:

success

code

integer

HTTP status code echoed in the body

message

string

data

object

Payment record returned by GET /payments/{id}, GET /payments, POST /payments/{id}/refresh, and idempotent replays. reference is YOUR merchant reference; the upstream payment identifier is external_id.

Show child attributes