List v2 payment orders (provider)
curl --request GET \
--url https://api.paycrest.io/v2/provider/orders \
--header 'API-Key: <api-key>'import requests
url = "https://api.paycrest.io/v2/provider/orders"
headers = {"API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'API-Key': '<api-key>'}};
fetch('https://api.paycrest.io/v2/provider/orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paycrest.io/v2/provider/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.paycrest.io/v2/provider/orders"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.paycrest.io/v2/provider/orders")
.header("API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paycrest.io/v2/provider/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "<string>",
"data": {
"total": 123,
"page": 123,
"pageSize": 123,
"orders": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "initiated",
"orderType": "regular",
"direction": "offramp",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"amount": "<string>",
"amountInUsd": "<string>",
"amountPaid": "<string>",
"amountReturned": "<string>",
"percentSettled": "<string>",
"rate": "<string>",
"senderFee": "<string>",
"senderFeePercent": "<string>",
"transactionFee": "<string>",
"reference": "<string>",
"txHash": "<string>",
"providerAccount": {
"network": "<string>",
"receiveAddress": "<string>",
"validUntil": "2023-11-07T05:31:56Z",
"amountToTransfer": "<string>",
"currency": "<string>",
"memo": "<string>"
},
"source": {
"type": "crypto",
"currency": "<string>",
"network": "ethereum",
"refundAddress": "<string>"
},
"destination": {
"type": "fiat",
"currency": "<string>",
"recipient": {
"institution": "<string>",
"accountIdentifier": "<string>",
"accountName": "<string>",
"memo": "<string>",
"institutionName": "<string>",
"metadata": {
"channel": "Mobile",
"businessNumber": "<string>"
}
},
"country": "<string>",
"providerId": "<string>",
"kyc": {
"entityType": "person",
"personDetails": {
"fullName": "<string>",
"birthDate": "2023-12-25",
"nationality": "<string>",
"contact": {
"email": "<string>",
"phoneE164": "<string>"
},
"idDocument": {
"type": "passport",
"number": "<string>",
"issuerCountry": "<string>"
},
"taxId": {
"type": "<string>",
"value": "<string>",
"country": "<string>"
}
},
"organizationDetails": {
"legalName": "<string>",
"tradingName": "<string>",
"registrationNumber": "<string>",
"registrationDate": "2023-12-25",
"registrationCountry": "<string>",
"contact": {
"email": "<string>",
"phoneE164": "<string>"
},
"taxId": {
"type": "<string>",
"value": "<string>",
"country": "<string>"
},
"directors": [
{
"personDetails": {
"fullName": "<string>",
"birthDate": "2023-12-25",
"nationality": "<string>",
"contact": {
"email": "<string>",
"phoneE164": "<string>"
},
"idDocument": {
"type": "passport",
"number": "<string>",
"issuerCountry": "<string>"
},
"taxId": {
"type": "<string>",
"value": "<string>",
"country": "<string>"
}
},
"role": "Director",
"ownershipPercentage": 123
}
]
},
"principalAddress": {
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
}
}
},
"statusDetail": "under_review",
"refundReason": "payer_mismatch"
}
]
}
}Provider
List Orders
Returns a paginated list of payment orders assigned to the authenticated provider, in the v2 response schema. Requires a currency query parameter. Supports optional direction (onramp / offramp), search, export=csv, from/to date filters, and ordering (asc/desc).
GET
/
provider
/
orders
List v2 payment orders (provider)
curl --request GET \
--url https://api.paycrest.io/v2/provider/orders \
--header 'API-Key: <api-key>'import requests
url = "https://api.paycrest.io/v2/provider/orders"
headers = {"API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'API-Key': '<api-key>'}};
fetch('https://api.paycrest.io/v2/provider/orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paycrest.io/v2/provider/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.paycrest.io/v2/provider/orders"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.paycrest.io/v2/provider/orders")
.header("API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paycrest.io/v2/provider/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "<string>",
"data": {
"total": 123,
"page": 123,
"pageSize": 123,
"orders": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "initiated",
"orderType": "regular",
"direction": "offramp",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"amount": "<string>",
"amountInUsd": "<string>",
"amountPaid": "<string>",
"amountReturned": "<string>",
"percentSettled": "<string>",
"rate": "<string>",
"senderFee": "<string>",
"senderFeePercent": "<string>",
"transactionFee": "<string>",
"reference": "<string>",
"txHash": "<string>",
"providerAccount": {
"network": "<string>",
"receiveAddress": "<string>",
"validUntil": "2023-11-07T05:31:56Z",
"amountToTransfer": "<string>",
"currency": "<string>",
"memo": "<string>"
},
"source": {
"type": "crypto",
"currency": "<string>",
"network": "ethereum",
"refundAddress": "<string>"
},
"destination": {
"type": "fiat",
"currency": "<string>",
"recipient": {
"institution": "<string>",
"accountIdentifier": "<string>",
"accountName": "<string>",
"memo": "<string>",
"institutionName": "<string>",
"metadata": {
"channel": "Mobile",
"businessNumber": "<string>"
}
},
"country": "<string>",
"providerId": "<string>",
"kyc": {
"entityType": "person",
"personDetails": {
"fullName": "<string>",
"birthDate": "2023-12-25",
"nationality": "<string>",
"contact": {
"email": "<string>",
"phoneE164": "<string>"
},
"idDocument": {
"type": "passport",
"number": "<string>",
"issuerCountry": "<string>"
},
"taxId": {
"type": "<string>",
"value": "<string>",
"country": "<string>"
}
},
"organizationDetails": {
"legalName": "<string>",
"tradingName": "<string>",
"registrationNumber": "<string>",
"registrationDate": "2023-12-25",
"registrationCountry": "<string>",
"contact": {
"email": "<string>",
"phoneE164": "<string>"
},
"taxId": {
"type": "<string>",
"value": "<string>",
"country": "<string>"
},
"directors": [
{
"personDetails": {
"fullName": "<string>",
"birthDate": "2023-12-25",
"nationality": "<string>",
"contact": {
"email": "<string>",
"phoneE164": "<string>"
},
"idDocument": {
"type": "passport",
"number": "<string>",
"issuerCountry": "<string>"
},
"taxId": {
"type": "<string>",
"value": "<string>",
"country": "<string>"
}
},
"role": "Director",
"ownershipPercentage": 123
}
]
},
"principalAddress": {
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
}
}
},
"statusDetail": "under_review",
"refundReason": "payer_mismatch"
}
]
}
}On provider order endpoints,
transactionFee is the protocol fee deducted from that order, net of any rebate once the order is settled. Before settlement it reflects the gross fee.Query Parameters
Filter to on-ramp (fiat → crypto) or off-ramp (crypto → fiat). Omit to include both directions.
On stats endpoints, invalid values return 400 Bad Request. On list endpoints, values other than onramp or offramp are ignored (no direction filter).
HMAC (GET): the signed payload includes all query parameters—include direction when you send it (alongside timestamp, currency, etc.).
Available options:
onramp, offramp