Introduction to Payouts

Please note! Quickpay Payouts is currently only available with Clearhaus.

Payout flow

Create a new payout
Credit the card using a link
Check payout status

1. Create a new payout in Quickpay

POST /payouts Create payout

First step is to create a new payout entity in Quickpay.

Selected parameters. See more in the API documentation.

Parameter	Description	Parameter type	Data type	Required?
order_id	Unique order number	form	string	true
currency	Currency	form	string	true

Example request:

1
2
3
4
5
6
curl -u ':APIKEY \
     -H 'content-type:application/json' \
     -H 'Accept-Version:v10' \
     -X POST \
     -d '{"order_id":"po1001","currency":"dkk"}' \
     https://api.quickpay.net/payouts

Example response (snippet):

1
2
3
4
5
6
7
8
9
{
  "id":99685805,
  "merchant_id":1234,
  "order_id":"po1001",
  "type":"Payout",
  "currency":"DKK",
  "state":"initial"
  ...
}

2. Credit the card using a link

PUT /payouts/{id}/link Authorize a payout

Next step is to create a payment link, where your customer can fill in their card information.

Selected parameters. See more in the API documentation.

Parameter	Description	Parameter type	Data type	Required?
id	Transaction id	path	integer	true
amount	Amount to authorize	form	integer	true

Example request:

1
2
3
4
5
6
curl -u ':APIKEY' \
     -H 'content-type:application/json' \
     -H 'Accept-Version:v10' \
     -X PUT \
     -d '{"amount":1000}' \
     https://api.quickpay.net/payouts/99685805/link

Example response:

1
2
3
{
  "url":"https://payment.quickpay.net/payouts/b4674ca58c6c8a2afeea105fb1b5ca22293a1dc17fa852afa0495010999c2d00"
}

When your customer has filled in their card information using the link, the payout is processed.

3. Check payout status

GET /payouts/{id} Get payout

Last step is to check the status of the payout.

This could be on a continue-url, where you render a “Payout successful”-message when the payout is complete.

Example request:

1
2
3
4
5
 curl -u ':APIKEY' \
     -H 'content-type:application/json' \
     -H 'Accept-Version:v10' \
     -X GET \
     https://api.quickpay.net/payouts/99685805

Example response (snippet):

1
2
3
4
5
6
7
8
9
{
  "id":99685805,
  "merchant_id":1234,
  "order_id":"po1001",
  "accepted":true,
  "type":"Payout",
  "state":"processed"
  ...
}