Connect

The Connect API is a collection of endpoints that enables a merchant to onboard sub-merchants and manage the flow of funds within SaaS platforms and Marketplaces.

Create Account

Create an account for a sub-merchant on your platform.

Headers
authorization String	Set value to `Bearer SECRET_KEY`
content-type String	Set value to `application/json`

Body Parameters
Show optional parameters
business_name String	The name of the sub-merchant’s business.
currency String	The currency of the sub-merchant’s business.
emails Array	The email or list of the emails of people who can manage operations for the sub-merchant.
split_type String	Either `flat` or `percentage`.
platform_share Integer	This is dependent on the `split_type`. You can pass an amount for the `flat` split or a `percentage` for the percentage split.
own_risk Boolean	This specifies if you are bearing the risk of the transactions from the sub-merchant. Set to `false` for Standard flow and `true` for Express flow.
require_onboarding Boolean	This specifies whether the sub-merchant needs to be onboarded on Paystack or not. Set to `true` for Standard flow and `false` for Express flow.
bank_code String	The bank code of the sub-merchant’s bank. This can be gotten from the List Bank endpoint.
account_number Integer	The sub-merchant’s account number.

1#!/bin/sh
2curl https://api.paystack.co/connect/accounts
3-H "Authorization: Bearer YOUR_SECRET_KEY"
4-H "Content-Type: application/json"
5-d '{ 
6      "business_name": "Boom Boom Lite",
7      "currency": "NGN",
8      "emails": ["tope@demo.com"],
9      "split_type": "percentage",
10      "platform_share": 1,
11      "own_risk": false,
12      "require_onboarding": true
13    }'
14-X POST

1{
2  "message": "Account created",
3  "data": {
4    "account_id": "C_ACT_4KRPYCAACP",
5    "business_name": "Boom Boom Lite",
6    "platform_integration_id": 463433,
7    "platform_slug": "test-boom-boom-ng",
8    "platform_id": "US2VSIMVAB",
9    "domain": "test",
10    "submerchant_integration_id": null,
11    "status": "created",
12    "currency": "NGN",
13    "emails": [
14      "tope@demo.com"
15    ],
16    "split_type": "percentage",
17    "platform_share": 1,
18    "setup_link": "https://connect.paystack.co/platform_name/onboarding?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50SWQiOiJDX0FDVF80S1JQWUNBQUNQIiwicGxhdGZvcm1JZCI6IlVTMlZTSU1WQUIiLCJpYXQiOjE3MTEwMjY1MTUsImV4cCI6MTcxMTYzMTMxNX0.ttR3Zv8Pw00n6tkeIU42eOrt5aH_aWk2e4mWEDhIy1A"
19  }
20}

List Accounts

Fetch the accounts of all sub-merchant’s on your integration.

Headers
authorization String	Set value to `Bearer SECRET_KEY`

Query Parameters
status String	Filter with one of the following options: `created`, `linked`, `disabled`, `deleted`.
account_id String	The account ID of the sub-merchant’s account

1#!/bin/sh
2url="https://api.paystack.co/connect/accounts"
3authorization="Authorization: Bearer YOUR_SECRET_KEY"
4
5curl "$url" -H "$authorization" -X GET

1{
2  "message": "Accounts retrieved",
3  "data": [
4    {
5      "account_id": "C_ACT_4KRPYCAACP",
6      "business_name": "Boom Boom Lite",
7      "platform_integration_id": 463433,
8      "platform_slug": "test-boom-boom-ng",
9      "platform_id": "US2VSIMVAB",
10      "domain": "test",
11      "submerchant_integration_id": null,
12      "status": "created",
13      "currency": "NGN",
14      "emails": [
15        "bren@test.com"
16      ],
17      "split_type": "percentage",
18      "platform_share": 1
19    },
20    {
21      "account_id": "C_ACT_9FFMF4284T",
22      "business_name": "Boom Boom Lite 2",
23      "platform_integration_id": 463433,
24      "platform_slug": "test-boom-boom-ng",
25      "platform_id": "US2VSIMVAB",
26      "domain": "test",
27      "submerchant_integration_id": null,
28      "status": "created",
29      "currency": "NGN",
30      "emails": [
31        "shegs@liquid.com"
32      ],
33      "split_type": "percentage",
34      "platform_share": 1
35    },
36    {
37      "account_id": "C_ACT_EAMHZFRFUK",
38      "business_name": "Boom Boom Lite 2",
39      "platform_integration_id": 463433,
40      "platform_slug": "test-boom-boom-ng",
41      "platform_id": "US2VSIMVAB",
42      "domain": "test",
43      "submerchant_integration_id": null,
44      "status": "created",
45      "currency": "NGN",
46      "emails": [
47        "tope@demo.com"
48      ],
49      "split_type": "flat",
50      "platform_share": 1
51    }
52  ],
53  "meta": {
54    "page": 1,
55    "perPage": 50,
56    "pageCount": 1,
57    "count": 3,
58    "total": 3,
59    "skipped": 0
60  }
61}

List Platforms

Get the platforms you are connected to as a submerchant account.

Headers
authorization String	Set value to `Bearer SECRET_KEY`

1#!/bin/sh
2url="https://api.paystack.co/connect/submerchant"
3authorization="Authorization: Bearer YOUR_SECRET_KEY"
4
5curl "$url" -H "$authorization" -X GET

1{
2  "message": "Accounts retrieved",
3  "data": [
4    {
5      "account_id": "C_ACT_D5F1SW094X",
6      "business_name": "standard account 1",
7      "platform_integration_id": 412754,
8      "platform_slug": "test-connection",
9      "platform_id": "ACSU8NBKC7",
10      "domain": "test",
11      "submerchant_integration_id": 19933,
12      "status": "linked",
13      "currency": "NGN",
14      "emails": [
15        "segun@test.com"
16      ],
17      "subaccount_code": "ACCT_4j6ews67s7uwj3g",
18      "split_type": "percentage",
19      "platform_share": 0,
20      "type": "standard",
21      "platform_business_name": "paystack-demo"
22    }
23  ],
24  "meta": {
25    "page": 1,
26    "perPage": 50,
27    "pageCount": 1,
28    "count": 1,
29    "total": 1,
30    "skipped": 0
31  }
32}

Fetch Account

Get the account details of a sub-merchant on your integration.

Headers
authorization String	Set value to `Bearer SECRET_KEY`

Path Parameters
account_id String	The ID of the sub-merchant’s account

1#!/bin/sh
2url="https://api.paystack.co/connect/accounts/{account_id}"
3authorization="Authorization: Bearer YOUR_SECRET_KEY"
4
5curl "$url" -H "$authorization" -X GET

1{
2  "status": true,
3  "message": "Account retrieved",
4  "data": {
5    "account_id": "C_ACT_EAMHZFRFUK",
6    "business_name": "Boom Boom Local",
7    "platform_integration_id": 463433,
8    "platform_slug": "test-boom-boom-ng",
9    "platform_id": "US2VSIMVAB",
10    "domain": "test",
11    "submerchant_integration_id": null,
12    "status": "linked",
13    "currency": "NGN",
14    "emails": [
15      "tope@demo.com"
16    ],
17    "split_type": "flat",
18    "platform_share": 2,
19    "type": "standard"
20  }
21}

Update Account

Update a sub-merchant's details on your integration

Headers
authorization String	Set value to `Bearer SECRET_KEY`
content-type String	Set value to `application/json`

Path Parameters
account_id String	The account ID of the sub-merchant’s account

Body Parameters
business_name String	The name of the sub-merchant’s business.
platform_share Integer	This is dependent on the `split_type`. You can pass an amount for the `flat` split or a `percentage` for the percentage split.

1#!/bin/sh
2url="https://api.paystack.co/connect/accounts/{account_id}"
3authorization="Authorization: Bearer YOUR_SECRET_KEY"
4content_type="Content-Type: application/json"
5data='{ 
6  "business_name": "Boom Boom Local",
7  "platform_share": 2000
8}'
9
10curl "$url" -H "$authorization" -H "$content_type" -d "$data" -X PATCH

1{
2  "message": "Account Updated Successfully",
3  "data": {
4    "account_id": "C_ACT_EAMHZFRFUK",
5    "business_name": "Boom Boom Local",
6    "platform_integration_id": 463433,
7    "platform_slug": "test-boom-boom-ng",
8    "platform_id": "US2VSIMVAB",
9    "domain": "test",
10    "submerchant_integration_id": null,
11    "status": "linked",
12    "currency": "NGN",
13    "emails": [
14      "tope@demo.com"
15    ],
16    "split_type": "flat",
17    "platform_share": 2000
18  }
19}

Detach Account

Initiate a request to remove a sub-merchant from your platform.

A detached account cannot be updated.

Headers
authorization String	Set value to `Bearer SECRET_KEY`
content-type String	Set value to `application/json`

Body Parameters
account_id String	The account ID of the sub-merchant’s account.

1#!/bin/sh
2curl https://api.paystack.co/connect/accounts/detach/submerchant
3-H "Authorization: Bearer YOUR_SECRET_KEY"
4-H "Content-Type: application/json"
5-d '{ 
6      "account_id": "C_ACT_EAMHZFRFUK"
7    }'
8-X POST

1{
2  "message": "Submerchant Account is unlinked",
3  "data": {
4    "account_id": "C_ACT_EAMHZFRFUK",
5    "business_name": "Boom Boom Lite 2",
6    "platform_integration_id": 463433,
7    "platform_slug": "test-boom-boom-ng",
8    "platform_id": "US2VSIMVAB",
9    "domain": "test",
10    "submerchant_integration_id": null,
11    "status": "disabled",
12    "currency": "NGN",
13    "emails": [
14      "tope@demo.com"
15    ],
16    "split_type": "flat",
17    "platform_share": 1
18  }
19}

Detach Platform

Initiate a request to remove a platform from your account, used by sub-merchants.

Headers
authorization String	Set value to `Bearer SECRET_KEY`
content-type String	Set value to `application/json`

Body Parameters
account_id String	The account ID of the sub-merchant’s account.

1#!/bin/sh
2curl https://api.paystack.co/connect/accounts/detach/platform
3-H "Authorization: Bearer YOUR_SECRET_KEY"
4-H "Content-Type: application/json"
5-d '{ 
6      "account_id": "C_ACT_EAMHZFRFUK"
7    }'
8-X POST

1{
2  "message": "Platform account is unlinked",
3  "data": {
4    "account_id": "C_ACT_D5F1SW094X",
5    "business_name": "demo account 1",
6    "platform_integration_id": 412754,
7    "platform_slug": "paystack-demo-ng",
8    "platform_id": "ACSU8NBKC7",
9    "domain": "test",
10    "submerchant_integration_id": 190933,
11    "status": "disabled",
12    "currency": "NGN",
13    "emails": [
14      "segun@example.com"
15    ],
16    "subaccount_code": "ACCT_4j6ews67s7uwj3g",
17    "split_type": "percentage",
18    "platform_share": 0,
19    "type": "standard"
20  }
21}

Attach Account

Initiate a request to add a previously detached sub-merchant back to your platform.

Headers
authorization String	Set value to `Bearer SECRET_KEY`
content-type String	Set value to `application/json`

Body Parameters
account_id String	The account ID of the sub-merchant’s account

1#!/bin/sh
2curl https://api.paystack.co/connect/accounts/attach/submerchant
3-H "Authorization: Bearer YOUR_SECRET_KEY"
4-H "Content-Type: application/json"
5-d '{ 
6      "account_id": "C_ACT_EAMHZFRFUK"
7    }'
8-X POST

1{
2  "message": "Submerchant account is linked",
3  "data": {
4    "account_id": "C_ACT_EAMHZFRFUK",
5    "business_name": "Boom Boom Lite 2",
6    "platform_integration_id": 463433,
7    "platform_slug": "test-boom-boom-ng",
8    "platform_id": "US2VSIMVAB",
9    "domain": "test",
10    "submerchant_integration_id": null,
11    "status": "linked",
12    "currency": "NGN",
13    "emails": [
14      "tope@demo.com"
15    ],
16    "split_type": "flat",
17    "platform_share": 1
18  }
19}

Regenerate Setup Link

Regenerate the link to invite a sub-merchant’s account to your platform.

Headers
authorization String	Set value to `Bearer SECRET_KEY`
content-type String	Set value to `application/json`

Body Parameters
account_id String	The account ID of the sub-merchant’s account.

1#!/bin/sh
2url="https://api.paystack.co/connect/accounts/{account_id}/setup-mail"
3authorization="Authorization: Bearer YOUR_SECRET_KEY"
4content_type="Content-Type: application/json"
5
6curl "$url" -H "$authorization" -H "$content_type" -d -X POST

1{
2  "message": "Setup link generated",
3  "data": {
4    "setup_link": "https://connect.paystack.com/paystack-demo-ng"
5  }
6}

List Platform Settlements

Fetch all the settlements belonging to the platform

Headers
authorization String	Set value to `Bearer SECRET_KEY`

1#!/bin/sh
2url="https://api.paystack.co/connect/settlement/platform"
3authorization="Authorization: Bearer YOUR_SECRET_KEY"
4
5curl "$url" -H "$authorization" -X GET

1{
2  "message": "Settlements retrieved",
3  "data": [
4    {
5      "id": 3629,
6      "domain": "test",
7      "status": "pending",
8      "currency": "NGN",
9      "integration": 190933,
10      "total_amount": 1350,
11      "effective_amount": 1350,
12      "total_fees": 0,
13      "total_processed": 10000,
14      "deductions": null,
15      "settlement_date": "2024-03-01T00:00:00.000Z",
16      "settled_by": null,
17      "createdAt": "2024-03-01T00:00:00.000Z",
18      "updatedAt": "2024-03-14T20:35:31.000Z",
19      "subaccount": {
20        "id": 4830,
21        "subaccount_code": "ACCT_wu9dpgqfcltqfkp",
22        "business_name": "test-business",
23        "description": "testing-business",
24        "primary_contact_name": null,
25        "primary_contact_email": null,
26        "primary_contact_phone": null,
27        "metadata": null,
28        "percentage_charge": 0,
29        "settlement_bank": "Access Bank",
30        "bank_id": 1,
31        "account_number": "001111111111",
32        "currency": "NGN",
33        "active": true
34      }
35    },
36    {
37      "id": 3625,
38      "domain": "test",
39      "status": "pending",
40      "currency": "NGN",
41      "integration": 190933,
42      "total_amount": 6050,
43      "effective_amount": 6050,
44      "total_fees": 0,
45      "total_processed": 20000,
46      "deductions": 1200,
47      "settlement_date": "2024-02-29T00:00:00.000Z",
48      "settled_by": null,
49      "createdAt": "2024-02-29T00:00:00.000Z",
50      "updatedAt": "2024-03-14T20:53:28.000Z",
51      "subaccount": {
52        "id": 4830,
53        "subaccount_code": "ACCT_wu9dpgqfcltqfkp",
54        "business_name": "testing-business",
55        "description": "testing-business",
56        "primary_contact_name": null,
57        "primary_contact_email": null,
58        "primary_contact_phone": null,
59        "metadata": null,
60        "percentage_charge": 0,
61        "settlement_bank": "Access Bank",
62        "bank_id": 1,
63        "account_number": "001111111111",
64        "currency": "NGN",
65        "active": true
66      }
67    },
68    {
69      "id": 3494,
70      "domain": "test",
71      "status": "success",
72      "currency": "NGN",
73      "integration": 190933,
74      "total_amount": 7050,
75      "effective_amount": 7050,
76      "total_fees": 0,
77      "total_processed": 20000,
78      "deductions": null,
79      "settlement_date": "2024-02-27T00:00:00.000Z",
80      "settled_by": null,
81      "createdAt": "2024-02-27T00:00:00.000Z",
82      "updatedAt": "2024-03-13T02:00:11.000Z",
83      "subaccount": {
84        "id": 4830,
85        "subaccount_code": "ACCT_wu9dpgqfcltqfkp",
86        "business_name": "testing-business",
87        "description": "testing-business",
88        "primary_contact_name": null,
89        "primary_contact_email": null,
90        "primary_contact_phone": null,
91        "metadata": null,
92        "percentage_charge": 0,
93        "settlement_bank": "Access Bank",
94        "bank_id": 1,
95        "account_number": "001111111111",
96        "currency": "NGN",
97        "active": true
98      }
99    },
100    {
101      "id": 3468,
102      "domain": "test",
103      "status": "success",
104      "currency": "NGN",
105      "integration": 190933,
106      "total_amount": 8750,
107      "effective_amount": 8750,
108      "total_fees": 0,
109      "total_processed": 20000,
110      "deductions": null,
111      "settlement_date": "2024-02-03T00:00:00.000Z",
112      "settled_by": null,
113      "createdAt": "2024-02-03T00:00:00.000Z",
114      "updatedAt": "2024-03-13T02:00:11.000Z",
115      "subaccount": {
116        "id": 4830,
117        "subaccount_code": "ACCT_wu9dpgqfcltqfkp",
118        "business_name": "testing-business",
119        "description": "testing-business",
120        "primary_contact_name": null,
121        "primary_contact_email": null,
122        "primary_contact_phone": null,
123        "metadata": null,
124        "percentage_charge": 0,
125        "settlement_bank": "Access Bank",
126        "bank_id": 1,
127        "account_number": "001111111111",
128        "currency": "NGN",
129        "active": true
130      }
131    },
132    {
133      "id": 3432,
134      "domain": "test",
135      "status": "success",
136      "currency": "NGN",
137      "integration": 190933,
138      "total_amount": 9750,
139      "effective_amount": 9750,
140      "total_fees": 0,
141      "total_processed": 30000,
142      "deductions": null,
143      "settlement_date": "2024-01-14T00:00:00.000Z",
144      "settled_by": null,
145      "createdAt": "2024-01-14T00:00:00.000Z",
146      "updatedAt": "2024-03-13T02:00:11.000Z",
147      "subaccount": {
148        "id": 4830,
149        "subaccount_code": "ACCT_wu9dpgqfcltqfkp",
150        "business_name": "testing-business",
151        "description": "testing-business",
152        "primary_contact_name": null,
153        "primary_contact_email": null,
154        "primary_contact_phone": null,
155        "metadata": null,
156        "percentage_charge": 0,
157        "settlement_bank": "Access Bank",
158        "bank_id": 1,
159        "account_number": "001111111111",
160        "currency": "NGN",
161        "active": true
162      }
163    }
164  ],
165  "meta": {
166    "page": 1,
167    "perPage": 50,
168    "pageCount": 1,
169    "count": 1,
170    "total": 1,
171    "skipped": 0
172  }
173}

List Transactions

List all the connect transactions on your platform.

Headers
authorization String	Set value to `Bearer SECRET_KEY`

Query Parameters
Show optional parameters
account_id String	Specify an ID for the particular submerchant whose transactions you want to retrieve
from Datetime	A timestamp from which to start listing transaction e.g. `2024-09-24T00:00:05.000Z`, `2024-09-21`
to Datetime	A timestamp at which to stop listing transaction e.g. `2024-09-24T00:00:05.000Z`, `2024-09-21`
perPage Integer	Specify how many records you want to retrieve per page. If not specified we use a default value of 50.

1#!/bin/sh
2url="https://api.paystack.co/connect/transaction/platform"
3authorization="Authorization: Bearer YOUR_SECRET_KEY"
4
5curl "$url" -H "$authorization" -X GET

1{
2  "message": "Transactions retrieved",
3  "data": [
4    {
5      "id": 4127021204,
6      "status": "success",
7      "reference": "uvbpoknq70",
8      "amount": 140120,
9      "gateway_response": "Successful",
10      "paid_at": "2024-08-30T10:31:34.000Z",
11      "created_at": "2024-08-30T10:31:21.000Z",
12      "channel": "card",
13      "currency": "NGN",
14      "metadata": null,
15      "log": null,
16      "fees": 2102,
17      "customer": {
18        "first_name": null,
19        "last_name": null,
20        "email": "customer@example.com",
21        "phone": null
22      },
23      "authorization": {
24        "exp_month": null,
25        "exp_year": null,
26        "reusable": false
27      },
28      "plan": {},
29      "split": {},
30      "subaccount": {},
31      "paidAt": "2024-08-30T10:31:34.000Z",
32      "createdAt": "2024-08-30T10:31:21.000Z",
33      "requested_amount": 140120,
34      "source": null,
35      "connect": {
36        "split_type": "flat",
37        "current": {
38          "share": 15000,
39          "amount": 12898
40        },
41        "can_resolve_claims": true,
42        "accounts": [
43          {
44            "account_id": "C_ACT_KU2DWU93SJ",
45            "subaccount": "ACCT_nuiv1u6878f8jqg",
46            "share": 125120,
47            "is_platform": false,
48            "account_type": "standard",
49            "merchant_on_record": true,
50            "platform_id": null,
51            "business_name": "Connect Demo Three",
52            "amount": 125120
53          },
54          {
55            "account_id": null,
56            "subaccount": "ACCT_9xhlnkw6n07lacm",
57            "share": 15000,
58            "is_platform": true,
59            "account_type": null,
60            "merchant_on_record": false,
61            "platform_id": "US2VSIMVAB",
62            "business_name": "Boom Boom NG",
63            "amount": 12898
64          }
65        ]
66      },
67      "pos_transaction_data": null
68    },
69    {
70      "id": 4120090915,
71      "status": "abandoned",
72      "reference": "slxpkliyph",
73      "amount": 140120,
74      "gateway_response": "The transaction was not completed",
75      "paid_at": null,
76      "created_at": "2024-08-28T11:02:27.000Z",
77      "channel": "card",
78      "currency": "NGN",
79      "metadata": null,
80      "log": null,
81      "fees": 2102,
82      "customer": {
83        "first_name": null,
84        "last_name": null,
85        "email": "customer@example.com",
86        "phone": null
87      },
88      "authorization": {
89        "exp_month": null,
90        "exp_year": null,
91        "reusable": false
92      },
93      "plan": {},
94      "split": {},
95      "subaccount": {},
96      "paidAt": null,
97      "createdAt": "2024-08-28T11:02:27.000Z",
98      "requested_amount": 140120,
99      "source": null,
100      "connect": {
101        "split_type": "percentage",
102        "current": {
103          "share": 40,
104          "amount": 53946
105        },
106        "can_resolve_claims": true,
107        "accounts": [
108          {
109            "account_id": "C_ACT_JQLLQ656XV",
110            "subaccount": "ACCT_g6uvq8qge0elp75",
111            "share": 60,
112            "is_platform": false,
113            "account_type": "standard",
114            "merchant_on_record": true,
115            "platform_id": null,
116            "business_name": "Testing account",
117            "amount": 84072
118          },
119          {
120            "account_id": null,
121            "subaccount": "ACCT_9xhlnkw6n07lacm",
122            "share": 40,
123            "is_platform": true,
124            "account_type": null,
125            "merchant_on_record": false,
126            "platform_id": "US2VSIMVAB",
127            "business_name": "Boom Boom NG",
128            "amount": 53946
129          }
130        ]
131      },
132      "pos_transaction_data": null
133    },
134    {
135      "id": 4120090640,
136      "status": "abandoned",
137      "reference": "nkmqx9bcqy",
138      "amount": 1400120,
139      "gateway_response": "The transaction was not completed",
140      "paid_at": null,
141      "created_at": "2024-08-28T11:02:21.000Z",
142      "channel": "card",
143      "currency": "NGN",
144      "metadata": null,
145      "log": null,
146      "fees": 31002,
147      "customer": {
148        "first_name": null,
149        "last_name": null,
150        "email": "test@paystack.com",
151        "phone": null
152      },
153      "authorization": {
154        "exp_month": null,
155        "exp_year": null,
156        "reusable": false
157      },
158      "plan": {},
159      "split": {},
160      "subaccount": {},
161      "paidAt": null,
162      "createdAt": "2024-08-28T11:02:21.000Z",
163      "requested_amount": 1400120,
164      "source": null,
165      "connect": {
166        "split_type": "percentage",
167        "current": {
168          "share": 40,
169          "amount": 529046
170        },
171        "can_resolve_claims": true,
172        "accounts": [
173          {
174            "account_id": "C_ACT_JQLLQ656XV",
175            "subaccount": "ACCT_g6uvq8qge0elp75",
176            "share": 60,
177            "is_platform": false,
178            "account_type": "standard",
179            "merchant_on_record": true,
180            "platform_id": null,
181            "business_name": "Testing account",
182            "amount": 840072
183          },
184          {
185            "account_id": null,
186            "subaccount": "ACCT_9xhlnkw6n07lacm",
187            "share": 40,
188            "is_platform": true,
189            "account_type": null,
190            "merchant_on_record": false,
191            "platform_id": "US2VSIMVAB",
192            "business_name": "Boom Boom NG",
193            "amount": 529046
194          }
195        ]
196      },
197      "pos_transaction_data": null
198    },
199    {
200      "id": 4120061327,
201      "status": "success",
202      "reference": "zcznwec0jb",
203      "amount": 1400120,
204      "gateway_response": "Successful",
205      "paid_at": "2024-08-28T10:56:47.000Z",
206      "created_at": "2024-08-28T10:51:55.000Z",
207      "channel": "card",
208      "currency": "NGN",
209      "metadata": null,
210      "log": null,
211      "fees": 31002,
212      "customer": {
213        "first_name": null,
214        "last_name": null,
215        "email": "customer@example.com",
216        "phone": null
217      },
218      "authorization": {
219        "exp_month": null,
220        "exp_year": null,
221        "reusable": false
222      },
223      "plan": {},
224      "split": {},
225      "subaccount": {},
226      "paidAt": "2024-08-28T10:56:47.000Z",
227      "createdAt": "2024-08-28T10:51:55.000Z",
228      "requested_amount": 1400120,
229      "source": null,
230      "connect": {
231        "split_type": "percentage",
232        "current": {
233          "share": 40,
234          "amount": 529046
235        },
236        "can_resolve_claims": true,
237        "accounts": [
238          {
239            "account_id": "C_ACT_JQLLQ656XV",
240            "subaccount": "ACCT_g6uvq8qge0elp75",
241            "share": 60,
242            "is_platform": false,
243            "account_type": "standard",
244            "merchant_on_record": true,
245            "platform_id": null,
246            "business_name": "Testing account",
247            "amount": 840072
248          },
249          {
250            "account_id": null,
251            "subaccount": "ACCT_9xhlnkw6n07lacm",
252            "share": 40,
253            "is_platform": true,
254            "account_type": null,
255            "merchant_on_record": false,
256            "platform_id": "US2VSIMVAB",
257            "business_name": "Boom Boom NG",
258            "amount": 529046
259          }
260        ]
261      },
262      "pos_transaction_data": null
263    }
264  ],
265  "meta": {
266    "next": null,
267    "previous": null,
268    "perPage": 50
269  }
270}

List Submerchant Settlements

Fetch settlements that belong to your submerchant account.

Headers
authorization String	Set value to `Bearer SECRET_KEY`

1#!/bin/sh
2url="https://api.paystack.co/connect/settlement/submerchant"
3authorization="Authorization: Bearer YOUR_SECRET_KEY"
4
5curl "$url" -H "$authorization" -X GET

1{
2  "message": "Settlements retrieved",
3  "data": [
4    {
5      "id": 3761,
6      "domain": "test",
7      "status": "pending",
8      "currency": "NGN",
9      "integration": 190933,
10      "total_amount": 18822,
11      "effective_amount": 18822,
12      "total_fees": 0,
13      "total_processed": 20306,
14      "deductions": null,
15      "settlement_date": "2024-07-08T00:00:00.000Z",
16      "settled_by": null,
17      "createdAt": "2024-07-08T00:00:00.000Z",
18      "updatedAt": "2024-07-09T20:17:07.000Z",
19      "subaccount": {
20        "id": 7281,
21        "subaccount_code": "ACCT_4j6ews67s7uwj3g",
22        "business_name": "standard account 1",
23        "description": "standard account 1",
24        "primary_contact_name": null,
25        "primary_contact_email": null,
26        "primary_contact_phone": null,
27        "metadata": null,
28        "percentage_charge": 0,
29        "settlement_bank": "Access Bank",
30        "bank_id": 1,
31        "account_number": "001111111111",
32        "currency": "NGN",
33        "active": true
34      }
35    },
36    {
37      "id": 3745,
38      "domain": "test",
39      "status": "pending",
40      "currency": "NGN",
41      "integration": 190933,
42      "total_amount": 700,
43      "effective_amount": 700,
44      "total_fees": 0,
45      "total_processed": 20000,
46      "deductions": null,
47      "settlement_date": "2024-07-07T00:00:00.000Z",
48      "settled_by": null,
49      "createdAt": "2024-07-07T00:00:00.000Z",
50      "updatedAt": "2024-07-07T00:43:08.000Z",
51      "subaccount": {
52        "id": 7281,
53        "subaccount_code": "ACCT_4j6ews67s7uwj3g",
54        "business_name": "standard account 1",
55        "description": "standard account 1",
56        "primary_contact_name": null,
57        "primary_contact_email": null,
58        "primary_contact_phone": null,
59        "metadata": null,
60        "percentage_charge": 0,
61        "settlement_bank": "Access Bank",
62        "bank_id": 1,
63        "account_number": "001111111111",
64        "currency": "NGN",
65        "active": true
66      }
67    },
68    {
69      "id": 3726,
70      "domain": "live",
71      "status": "pending",
72      "currency": "NGN",
73      "integration": 190933,
74      "total_amount": 18121,
75      "effective_amount": 18121,
76      "total_fees": 0,
77      "total_processed": 20306,
78      "deductions": null,
79      "settlement_date": "2024-06-29T00:00:00.000Z",
80      "settled_by": null,
81      "createdAt": "2024-06-29T00:00:00.000Z",
82      "updatedAt": "2024-06-28T12:50:26.000Z",
83      "subaccount": {
84        "id": 7281,
85        "subaccount_code": "ACCT_4j6ews67s7uwj3g",
86        "business_name": "standard account 1",
87        "description": "standard account 1",
88        "primary_contact_name": null,
89        "primary_contact_email": null,
90        "primary_contact_phone": null,
91        "metadata": null,
92        "percentage_charge": 0,
93        "settlement_bank": "Access Bank",
94        "bank_id": 1,
95        "account_number": "001111111111",
96        "currency": "NGN",
97        "active": true
98      }
99    },
100    {
101      "id": 3711,
102      "domain": "live",
103      "status": "pending",
104      "currency": "NGN",
105      "integration": 190933,
106      "total_amount": 18984,
107      "effective_amount": 18984,
108      "total_fees": 0,
109      "total_processed": 20306,
110      "deductions": null,
111      "settlement_date": "2024-06-26T00:00:00.000Z",
112      "settled_by": null,
113      "createdAt": "2024-06-26T00:00:00.000Z",
114      "updatedAt": "2024-06-25T13:04:42.000Z",
115      "subaccount": {
116        "id": 7281,
117        "subaccount_code": "ACCT_4j6ews67s7uwj3g",
118        "business_name": "standard account 1",
119        "description": "standard account 1",
120        "primary_contact_name": null,
121        "primary_contact_email": null,
122        "primary_contact_phone": null,
123        "metadata": null,
124        "percentage_charge": 0,
125        "settlement_bank": "Access Bank",
126        "bank_id": 1,
127        "account_number": "001111111111",
128        "currency": "NGN",
129        "active": true
130      }
131    }
132  ],
133  "meta": {
134    "next": null,
135    "previous": null,
136    "perPage": 50
137  }
138}