Skip to content

Payouts

Payouts⚓

Warning

Currently payouts exist only in live mode. Those routes return 501 Not implemented error if you use a test mode API key.

Payouts are the credit transferts regularly sent by Stancer to your bank to transfer your collections processed with Stancer. Each payout contains your customer's payments, refunds and potential disputes. Therefore, a payout object is structured as follows :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "amount": 9400,
  "created": 1642744806,
  "currency": "eur",
  "date_bank": null,
  "date_paym": 1642633200,
  "fees": 100,
  "id": "pout_GexV3lpllrBkyRny15qfsMC0",
  "live_mode": true,
  "payments": {
    "amount": 15000
  },
  "refunds": {
    "amount": 5000
  },
  "disputes": {
    "amount": 500
  },
  "statement_description": "Stancer Payout Statement",
  "status": "paid"
}

The payout object is defined as follows:

Parameter Description Type
id Payout id String, fixed size = 29
amount The total credit tranfer amount you will receive Int
currency Processed currency Enum EUR
date_paym The date the payment transactions were made  Timestamp, Int
date_bank The date you will receive the credit tranfer  Timestamp, Int
fees The fees you paid for processing the payments Int
payments Payments processed the date_paym date Object
refunds Refunds processed the date_paym date Object
disputes Disputes received the date_paym date Object
statement_description The statement description which will be displayed on your bank account String
status Payout status See payout status codes
created Payout creation's timestamp Int

Get the payout list⚓

HTTP request⚓

/v1/payouts/
?created=
created
&start=
start
&limit=
limit

Query parameters⚓

Parameter Field Description Type
created Optional A Unix timestamp filtering payments whom timestamps are equal to or greater Int
limit Optional An integer value limiting the number of objects to be returned Int, min = 1, max = 100, default = 10
start Optional An integer cursor you can use for pagination starting at index 0 Int, default = 0 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
    "live_mode": true,
    "payouts": [
    {
      "amount": 9400,
      "created": 1642744806,
      "currency": "eur",
      "date_bank": null,
      "date_paym": 1642633200,
      "fees": 100,
      "id": "pout_GexV3lpllrBkyRny15qfsMC0",
      "live_mode": true,
      "payments": {
        "amount": 15000
      },
      "refunds": {
        "amount": 5000
      },
      "disputes": {
        "amount": 500
      },
      "statement_description": "Stancer Payout Statement",
      "status": "paid"
    }
    ],
    "range": {
        "created": 1585127453,
        "end": 0,
        "has_more": true,
        "limit": 1,
        "order_id": null,
        "start": 0,
        "unique_id": null
    }
}

Get a payout detail⚓

HTTP request⚓

/v1/payouts/
id_payout
/
type
/
?created=
created
&start=
start
&limit=
limit

Query parameters⚓

Parameter Field Description Type
type Payout type can be payments, refunds, disputes String
created Optional A Unix timestamp filtering payments whom timestamps are equal to or greater Int
limit Optional An integer value limiting the number of objects to be returned Int, min = 1, max = 100, default = 10
start Optional An integer cursor you can use for pagination starting at index 0 Int, default = 0

This endpoint will return an object type list as previously described such as List all payments