API Reference

Create payout order

post
https://{environment}.gifq.com/api/payout-orders

Dispatches a payout order for a campaign. Recipients are notified by email and can redeem their gift card at the configured redeem URL. The order is processed asynchronously — a 202 Accepted response confirms the order was received and queued.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

ID of the campaign to send payouts under

string

ISO currency code of the GIFQ wallet charged for this order. Required for campaigns that include the gift_cards payout type, because the gift cards are bought from that wallet. Must be omitted for crypto-only campaigns: no wallet is charged, and the order is denominated in the recipients' own currency, which every recipient must then share.

recipients
array of objects
required

List of recipients to receive a payout

recipients*
integer
required

Number of days before the recipient link expires

string

Ledger account ID used to fund crypto payouts. Required when the campaign supports crypto payouts.

uri

Optional HTTPS URL that will receive signed webhook POSTs whenever the payout order transitions status. See the X-Gifq-Signature HMAC-SHA256 header for verification.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?