POST
/api/v2/payments/requestsCreate a payment request
Authentication
Send your API key in the x-api-key header on every request.
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| UserId | unknown | Yes | |
| Amount | string | Yes | |
| Currency | string | Yes | |
| Description | string | No | |
| ExternalReferenceId | string | No | |
| CallbackUrl | string | No | |
| SuccessUrl | string | No | |
| FailureUrl | string | No | |
| Metadata | object | No |
Responses
201 — Created
| Field | Type | Required | Description |
|---|---|---|---|
| Id | unknown | No | |
| UserId | unknown | No | |
| CompanyId | unknown | No | |
| Amount | string | No | |
| Currency | string | No | |
| Status | PaymentStatusV2 | No | |
| Description | string | No | |
| ExternalReferenceId | string | No | |
| CallbackUrl | string | No | |
| SuccessUrl | string | No | |
| FailureUrl | string | No | |
| PaymentUrl | string | No | |
| CreatedAt | string | No | |
| UpdatedAt | string | No | |
| CompletedAt | string | No |
400 — Bad Request
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
404 — Not Found
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
500 — Internal Server Error
| Field | Type | Required | Description |
|---|---|---|---|
| Message | string | No | |
| Code | string | No | |
| Status | unknown | No | |
| ValidationErrors | object | No | |
| Details | string | No |
Example request
curl -X POST "https://{base_url}/api/v2/payments/requests" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"UserId":"…","Amount":"…","Currency":"…"}'This page is generated from the live OpenAPI specification and always matches the current API.