Create Quote

POST /v0/customers/{customer_id}/pay-out/quote

Create a payout quote for a customer.

Path parameters

  • customer_id (string · uuid) — Required The unique identifier of the customer.

Header parameters

  • Authorization (string) — Required Token for authentication.

  • Idempotency-Key (string) — Required Unique key to prevent duplicate requests.

Body (application/json)

Either source_amount OR destination_amount must be provided to calculate the quote in the desired direction.

You can provide one of the following objects:

  • BySourceAmount (object) — Optional Provide source-side details to calculate destination.

  • ByDestinationAmount (object) — Optional Provide destination-side details to calculate source.

circle-info

Either source_amount OR destination_amount must be present — do not provide both as the primary direction of the quote must be specified.

Request example (raw HTTP)

Responses

  • 201 — Quote created successfully Content-Type: application/json Response: object

Response example (201 Created)

Last updated