Authentication

Requires product-api-token (sent via the configured auth header as a JWT bearer token) headers.

Request body

JSON payload containing the documented payment fields.

Required fields:

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

Common optional fields:

• paymentMethods (array of strings: card | crypto | bank_transfer)
• paymentMethod (string: card | crypto | bank_transfer)
• cardPaymentType (on_ramp for on-ramp HPP only)
• orderReference (string)
• customerReference (string)
• successUrl (string URL)
• failureUrl (string URL)
• expiryTime (string datetime)
• useHostedPaymentPage (boolean)
• metadata (object)

For an on-ramp HPP payment, set paymentMethod to card, useHostedPaymentPage to true, and cardPaymentType to on_ramp. Send the selected metadata.asset and metadata.network from GET /product-apis/on-ramp-networks. Idempotency-Key is required for this payment type.

Response

201: Payment created successfully. Returned data includes:

• paymentId
• status (created | processing | completed | failed | expired | refunded | cancelled)
• amount
• currency
• paymentMethod (card | crypto | bank_transfer)
• orderReference (string or null)
• customerReference (string or null)
• hostedPaymentUrl (string or null)
• expiresAt (ISO 8601 datetime string or null)
• instructions (object or null)
• createdAt (ISO 8601 datetime string)

400: Bad request

401: Unauthorized

403: Forbidden

503: Service unavailable

500: Internal server error