Create or return a deposit, full payment or remaining balance checkout (balance needs payments:write)

post/api/v1/bookings/{reference}/payment-requests

Request

  • Base URL: http://127.0.0.1:4310
  • URL: http://127.0.0.1:4310/api/v1/bookings/{reference}/payment-requests
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sfb_session

Path parameters

referencestring required

Request body

purpose'deposit' | 'full' | 'balance'
idempotency_keystring

Response

OK

object required

Changes

No recorded changes to this operation across all 4 revisions of this API.