Foxpay

Public API docs for Foxpay custom REST integrations.

Public APICustom REST integrationv0.1
Payment method

Open bank transfer

Use Foxpay open bank transfer flows either through hosted Foxpay checkout or as a direct Calytics A2A/OBT provider handoff.

Integration type

OBT

Primary amount field

amountCents

Buyer handoff

paymentUrl from the initializer response

Route focus

  • POST /payments/initialize creates the hosted checkout handoff by default.
  • POST /payments/initialize with `paymentMethod: open_bank_transfer` and `checkoutMode: direct_provider` creates a direct provider session.
  • GET /payments/{paymentId}/status supports buyer-facing progress polling.
  • GET /payments/{paymentId}/bank-details returns transfer instructions when manual bank details are needed.

Implementation guidance

  • Send `amountCents`, not major-unit floats, on the custom REST integration path.
  • Use `remittanceInfo` to control the SEPA remittance/payment reference; Foxpay generates a safe fallback when omitted.
  • Persist `paymentId`, `orderId`, `merchantId`, and `testMode` before redirecting the buyer.
  • Use polling for buyer feedback and backend reconciliation for the final order state.
  • Confirm the merchant has the requested payment method enabled before live rollout.