POST/api/v2/payments/create

Create a payment with automatic currency exchange and transfer

Authentication

Send your API key in the x-api-key header on every request.

Request body

application/json

Request body fields
FieldTypeRequiredDescription
UserIdunknownYes
AmountstringYes
CurrencystringYes
DescriptionstringNo
MerchantReferenceIdstringNo
MandateIdunknownNo
MetadataobjectNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
IdunknownNo
StatusstringNo
MessagestringNo
TransactionIdunknownNo
TransferIdstringNo
ExchangeQuoteobjectNo
ExchangeTradeIdstringNo
RequiredAmountstringNo
AvailableAmountstringNo
ShortfallstringNo
TransakOrderobjectNo
AmountstringNo
CurrencystringNo
UserIdunknownNo
CompanyIdunknownNo
MandateIdunknownNo
CreatedAtstringNo

400 — Bad Request

Response 400 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

404 — Not Found

Response 404 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X POST "https://{base_url}/api/v2/payments/create" \
  -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.