Retrieve account
Returns the account for the authenticated key: merchant id, display profile, chargeable currencies grouped by payment method type, live activation status, and the key's own type, mode, and permissions. Works with any secret or restricted key, and requires no specific permission. Publishable keys are refused.
Returns the account for the authenticated key: merchant id, display profile, chargeable currencies grouped by payment method type, live activation status, and the key's own type, mode, and permissions. Works with any secret or restricted key, and requires no specific permission. Publishable keys are refused.
Authorization
api-key API key for merchant integrations. Send as Authorization: Bearer <your key>.
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/account"{
"id": "acct_TzcstOSVIgqLtvV73P8eZDkc",
"displayName": "Cairo Books",
"country": "EG",
"defaultCurrency": "EGP",
"defaultLocale": "en",
"supportedCurrencies": [
{
"code": "EGP",
"decimals": 2,
"paymentMethodTypes": [
"card"
]
}
],
"livemode": false,
"livePaymentsEnabled": true,
"apiKey": {
"type": "SECRET",
"mode": "test",
"permissions": [
"BALANCE_READ"
]
}
}{
"error": {
"type": "authentication_error",
"code": "authentication_required",
"message": "No valid API key provided.",
"doc_url": "https://docs.xpay.app/integrate/errors/api-error-codes#authentication_required"
},
"request_id": "req_abc123def456"
}{
"error": {
"type": "invalid_request_error",
"code": "permission_denied",
"message": "The API key does not have permission to perform this action.",
"doc_url": "https://docs.xpay.app/integrate/errors/api-error-codes#permission_denied"
},
"request_id": "req_abc123def456"
}{
"error": {
"type": "api_error",
"code": "internal_error",
"message": "An unexpected error occurred. Please try again or contact support.",
"doc_url": "https://docs.xpay.app/integrate/errors/api-error-codes#internal_error"
},
"request_id": "req_abc123def456"
}