Bank Accounts

Part of the Partners API. Base URL https://your-domain.com/admin/api/v1 — replace the host with your own installation and the token placeholder with a real Bearer token (see Authentication).

List bank accounts

GET /admin/api/v1/partners/partners/{partner_id}/bank-accounts

Retrieve a paginated list of bank accounts for a specific partner with filtering and sorting

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`partner_id`	integer	Yes	The partner ID

Query parameters

Parameter	Type	Required	Description	Example
`include`	string	No	Comma-separated list of relationships to include. Available options: bank, creator	`bank`
`filter[id]`	string	No	Comma-separated list of IDs to filter by
`filter[bank_id]`	string	No	Comma-separated list of bank IDs to filter by
`filter[trashed]`	string	No	Filter by trashed status. Available options: with, without, only
`sort`	string	Yes	Sort field	`created_at`
`page`	integer	Yes	Page number	`1`

cURLJavaScriptPHPPython

bash

curl -X GET "https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts?include=bank&sort=created_at&page=1" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts?include=bank&sort=created_at&page=1", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts?include=bank&sort=created_at&page=1', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts?include=bank&sort=created_at&page=1"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": [
    {
      "id": null,
      "account_number": "573051510872642",
      "account_holder_name": "Wendy Weimann I",
      "can_send_money": true,
      "bank_id": 1,
      "created_at": null,
      "updated_at": null
    },
    {
      "id": null,
      "account_number": "9437223018164202",
      "account_holder_name": "Ethelyn Jacobs",
      "can_send_money": true,
      "bank_id": 2,
      "created_at": null,
      "updated_at": null
    }
  ],
  "links": {
    "first": "/?page=1",
    "last": "/?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "page": null,
        "active": false
      },
      {
        "url": "/?page=1",
        "label": "1",
        "page": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "page": null,
        "active": false
      }
    ],
    "path": "/",
    "per_page": 10,
    "to": 2,
    "total": 2
  }
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Create bank account

POST /admin/api/v1/partners/partners/{partner_id}/bank-accounts

Create a new bank account for a specific partner

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`partner_id`	integer	Yes	The partner ID

Body parameters

Parameter	Type	Required	Description
`account_number`	string	Yes	Bank account number (max 255 characters). Must not be greater than 255 characters.
`can_send_money`	boolean	Yes	Whether money can be sent from this account.
`bank_id`	integer	Yes	Bank ID. Must match an existing stored value.

cURLJavaScriptPHPPython

bash

curl -X POST "https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "account_number": "1234567890",
  "can_send_money": true,
  "bank_id": 1
}'

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "account_number": "1234567890",
  "can_send_money": true,
  "bank_id": 1
}),
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
    'account_number' => '1234567890',
    'can_send_money' => true,
    'bank_id' => 1,
  ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

payload = {
    "account_number": "1234567890",
    "can_send_money": True,
    "bank_id": 1,
}

response = requests.post(url, headers=headers, json=payload)

data = response.json()
print(data)

Example response 201

json

{
  "data": {
    "id": null,
    "account_number": "88002631600564",
    "account_holder_name": "Mr. Gerhard Dach Jr.",
    "can_send_money": true,
    "bank_id": 3,
    "created_at": null,
    "updated_at": null
  },
  "message": "Bank account created successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Show bank account

GET /admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}

Retrieve a specific bank account by its ID

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`partner_id`	integer	Yes	The partner ID
`id`	integer	Yes	The bank account ID

Query parameters

Parameter	Type	Required	Description	Example
`include`	string	No	Comma-separated list of relationships to include. Available options: bank, creator	`bank`

cURLJavaScriptPHPPython

bash

curl -X GET "https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}?include=bank" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}?include=bank", {
  method: "GET",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}?include=bank', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}?include=bank"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": null,
    "account_number": "031881",
    "account_holder_name": "Miss Jazlyn Keebler III",
    "can_send_money": true,
    "bank_id": 4,
    "created_at": null,
    "updated_at": null
  }
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Update bank account

PUT /admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}

Update an existing bank account

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`partner_id`	integer	Yes	The partner ID
`id`	integer	Yes	The bank account ID

Body parameters

Parameter	Type	Required	Description
`account_number`	string	No	Bank account number (max 255 characters). Must not be greater than 255 characters.
`can_send_money`	boolean	No	Whether money can be sent from this account.
`bank_id`	integer	No	Bank ID. Must match an existing stored value.

cURLJavaScriptPHPPython

bash

curl -X PUT "https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "account_number": "1234567890",
  "can_send_money": true,
  "bank_id": 1
}'

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "account_number": "1234567890",
  "can_send_money": true,
  "bank_id": 1
}),
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
    'account_number' => '1234567890',
    'can_send_money' => true,
    'bank_id' => 1,
  ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

payload = {
    "account_number": "1234567890",
    "can_send_money": True,
    "bank_id": 1,
}

response = requests.put(url, headers=headers, json=payload)

data = response.json()
print(data)

Example response 200

json

{
  "data": {
    "id": null,
    "account_number": "88002631600564",
    "account_holder_name": "Mr. Gerhard Dach Jr.",
    "can_send_money": true,
    "bank_id": 5,
    "created_at": null,
    "updated_at": null
  },
  "message": "Bank account updated successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Delete bank account

DELETE /admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}

Soft delete a bank account

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`partner_id`	integer	Yes	The partner ID
`id`	integer	Yes	The bank account ID

cURLJavaScriptPHPPython

bash

curl -X DELETE "https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.delete(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "message": "Bank account deleted successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Restore bank account

POST /admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}/restore

Restore a soft-deleted bank account

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`partner_id`	integer	Yes	The partner ID
`id`	integer	Yes	The bank account ID

cURLJavaScriptPHPPython

bash

curl -X POST "https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}/restore" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}/restore", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}/restore', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}/restore"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.post(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "message": "Bank account restored successfully."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Force delete bank account

DELETE /admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}/force

Permanently delete a bank account

🔒 Requires a valid Bearer token.

Path parameters

Parameter	Type	Required	Description
`partner_id`	integer	Yes	The partner ID
`id`	integer	Yes	The bank account ID

cURLJavaScriptPHPPython

bash

curl -X DELETE "https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}/force" \
  -H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

javascript

const response = await fetch("https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}/force", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

php

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}/force', [
    'headers' => [
        'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

python

import requests

url = "https://your-domain.com/admin/api/v1/partners/partners/{partner_id}/bank-accounts/{id}/force"

headers = {
    "Authorization": "Bearer {YOUR_AUTH_TOKEN}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

response = requests.delete(url, headers=headers)

data = response.json()
print(data)

Example response 200

json

{
  "message": "Bank account permanently deleted."
}

Error response — 401

json

{
  "message": "Unauthenticated."
}

Bank Accounts ​

List bank accounts ​

Create bank account ​

Show bank account ​

Update bank account ​

Delete bank account ​

Restore bank account ​

Force delete bank account ​

Bank Accounts

List bank accounts

Create bank account

Show bank account

Update bank account

Delete bank account

Restore bank account

Force delete bank account