Jèko
Payment Requests

Create payment request (Partner API)

POST
/partner_api/payment_requests

Authorization

ApiKey ApiKeyId
X-API-KEY<token>

In: header

X-API-KEY-ID<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/partner_api/payment_requests" \  -H "Content-Type: application/json" \  -d '{    "amountCents": 100,    "currency": "str",    "reference": "string",    "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",    "paymentDetails": {      "type": "redirect",      "data": {        "paymentMethod": "orange",        "successUrl": "http://example.com",        "errorUrl": "http://example.com"      }    }  }'
{  "id": "string",  "storeId": "string",  "reference": "string",  "type": "redirect",  "paymentMethod": "orange",  "status": "pending",  "errorReason": "string",  "transaction": {    "id": "string",    "amount": {      "amount": 0,      "currency": "XOF"    },    "fees": {      "amount": 0,      "currency": "XOF"    },    "status": "pending",    "counterpartLabel": "string",    "counterpartIdentifier": "string",    "description": "string",    "executedAt": "string"  },  "redirectUrl": "http://example.com"}

Get store balance (Partner API) GET

Returns the total available balance for a specific store. The balance represents the sum of available balances from all wallets associated with the store. **Balance Information:** - Returns the total available balance across all wallets for the store - Available balance = total balance - blocked balance - Balance is returned in the store's currency - Amount is in cents (smallest currency unit) **Use Cases:** - Check store balance before creating transfers - Display balance information in dashboards - Monitor store financial status - Validate sufficient funds for operations **Authentication:** Requires API key headers.

Get payment request by ID (Partner API) GET

Retrieves a payment request by its ID. Returns the same structure as the create endpoint but includes the current status. When the request is still pending and a PSP status check was recently performed (or just ran), the response may include a `Retry-After` header (seconds) advising clients when to poll again. **Authentication:** - Requires API key headers `X-API-KEY` and `X-API-KEY-ID` **Access Control:** - Only returns payment requests that belong to the authenticated business - Only returns payment requests created via the Partner API