Skip to main content
GET
/
v1
/
escrow
/
claim-funds
/
{paymentToken}
Claim funds
curl --request GET \
  --url https://staging.api.payluk.ng/v1/escrow/claim-funds/{paymentToken} \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "message": "Funds claimed successfully",
  "data": {
    "paymentToken": "PY_8AB12C9D3045",
    "status": "CLAIMED",
    "state": "OPENED"
  }
}

Authorizations

​
Authorization
string
header
required

Your secret key as a Bearer token. The key prefix selects the environment: sk_test_... (test) or sk_live_... (live).

Path Parameters

​
paymentToken
string
required

The escrow's payment token (e.g. PY_8AB12C9D3045).

Response

Funds claimed.

Standard response envelope with an empty or minimal data object.

​
status
integer
Example:

200

​
message
string
Example:

"Operation successful"

​
data
object