Get payment status

GET

/payment/status/{orderId}

const url = 'https://api.pipevest.com/v1/payment/status/clx0a1b2c3d4e5f6g7h8i9j0k';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'x-client-id': '<x-client-id>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.pipevest.com/v1/payment/status/clx0a1b2c3d4e5f6g7h8i9j0k \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-id: <x-client-id>'

Returns the status of the collection (C2B, payment) and/or disbursement (B2C, disbursement) for an order. Poll this endpoint to learn a payment outcome — signed outbound webhooks are not available yet.

Authorizations

bearerAuth
clientId

Parameters

Path Parameters

orderId

required

string

Example

clx0a1b2c3d4e5f6g7h8i9j0k

Order identifier (CUID string).

Responses

200

Transaction status

application/json

object

message

string

data

object

orderId

string

payment

object

string

type

INCOMING = C2B collection, OUTGOING = B2C disbursement.

string

Allowed values: INCOMING OUTGOING

amount

string

currency

string

status

string

Allowed values: PENDING PROCESSING CONFIRMED FAILED EXPIRED

provider

string

Allowed values: ZAMTEL MTN AIRTEL

telcoTransactionId

string

nullable

telcoConversationId

string

nullable

confirmedAt

string format: date-time

nullable

failedAt

string format: date-time

nullable

failureReason

string

nullable

createdAt

string format: date-time

disbursement

object

string

type

INCOMING = C2B collection, OUTGOING = B2C disbursement.

string

Allowed values: INCOMING OUTGOING

amount

string

currency

string

status

string

Allowed values: PENDING PROCESSING CONFIRMED FAILED EXPIRED

provider

string

Allowed values: ZAMTEL MTN AIRTEL

telcoTransactionId

string

nullable

telcoConversationId

string

nullable

confirmedAt

string format: date-time

nullable

failedAt

string format: date-time

nullable

failureReason

string

nullable

createdAt

string format: date-time

Example

{
  "message": "Transaction status retrieved successfully",
  "data": {
    "orderId": "clx0a1b2c3d4e5f6g7h8i9j0k",
    "payment": {
      "id": "clpaya1b2c3d4e5f6g7h8i9j0",
      "type": "INCOMING",
      "amount": "150.00",
      "currency": "ZMW",
      "status": "PENDING",
      "provider": "ZAMTEL"
    },
    "disbursement": {
      "id": "clpaya1b2c3d4e5f6g7h8i9j0",
      "type": "INCOMING",
      "amount": "150.00",
      "currency": "ZMW",
      "status": "PENDING",
      "provider": "ZAMTEL"
    }
  }
}

401

Authentication failed

application/json

object

error

string

message

string

Example

{
  "error": "Unauthorized",
  "message": "Invalid organization authentication token"
}

404

No payment or disbursement found for the order

application/json

object

error

string

message

string

Example

{
  "error": "Transaction not found",
  "message": "No payment or disbursement transaction found for order clx0a1b2c3d4e5f6g7h8i9j0k"
}

500

Server error

application/json

object

error

string

message

string

Example

{
  "error": "Unauthorized",
  "message": "Invalid organization authentication token"
}