Skip to main content
GET
/
payments
/
provider-configs
/
{config_id}
Get provider config by config ID (admin)
curl --request GET \
  --url https://prod-api.pcxpay.com/v1/payments/provider-configs/{config_id} \
  --header 'Authorization: <authorization>' \
  --header 'X-Api-Key: <x-api-key>'
{
  "provider": "manual",
  "country": "NG",
  "payment_method": "bank_transfer",
  "direction": "inbound",
  "api_version": "<string>",
  "priority": 123,
  "is_active": true,
  "webhook_required": true,
  "org_id": "<string>",
  "min_amount": 123,
  "max_amount": 123,
  "description": "<string>",
  "webhook_url": "<string>",
  "config_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.pcxpay.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
default:NONE
required

Bearer JWT for user-facing flows (Bearer eyJraWQ...), or the literal string NONE when authenticating via API key.

Example:

"Bearer eyJraWQ..."

​
X-Api-Key
string
default:NONE
required

API key for server-to-server flows, or the literal string NONE when authenticating via JWT.

Example:

"pcx_abc123_xxxx"

Path Parameters

​
config_id
string
required

Response

Provider config

​
provider
enum<string>
required
Available options:
manual,
crypto,
fiat,
hybrid,
sarepay,
paystack,
flutterwave,
truelayer,
yellowcard,
stripe,
paypal,
trustpayment,
squad
​
country
string
required
Example:

"NG"

​
payment_method
enum<string>
required
Available options:
bank_transfer,
card,
mobile_money,
crypto,
wallet
​
direction
enum<string>
required
Available options:
inbound,
outbound,
external
​
api_version
string
​
priority
integer

Lower number = higher priority

​
is_active
boolean
​
webhook_required
boolean
​
org_id
string | null

Scope this config to a specific organisation; null = global

​
min_amount
number<float>
​
max_amount
number<float>
​
description
string
​
webhook_url
string<uri>
​
config_id
string
​
created_at
string<date-time>
​
updated_at
string<date-time>