Create a payment

Create a payment.

Authentication

Requires X-Access-Key and X-Secret-Key headers.

Request body

JSON payload matching CreatePaymentDto.

Required fields:

  • amount (number, min 0.01)
  • currency (string)

Common optional fields:

  • paymentMethods (array of strings: card | crypto | bank_transfer)
  • paymentMethod (string: card | crypto | bank_transfer)
  • orderReference (string)
  • customerReference (string)
  • successUrl (string URL)
  • failureUrl (string URL)
  • expiryTime (string datetime)
  • useHostedPaymentPage (boolean)
  • metadata (object)

Response

  • 201: Payment created successfully. Returned data (PaymentResponseDto) includes:
    • paymentId
    • status (created | processing | completed | failed | expired | refunded)
    • amount
    • currency
    • paymentMethod (card | crypto | bank_transfer)
    • orderReference (object in schema; may be provided by your integration)
    • customerReference (object in schema; may be provided by your integration)
    • hostedPaymentUrl (object)
    • expiresAt (object)
    • instructions (object)
    • createdAt
  • 400: Bad request
  • 401: Unauthorized
  • 403: Forbidden
  • 500: Internal server error
Language
Credentials
Response
Click Try It! to start a request and see the response here!