Kobble
  1. Beneficiaries
Kobble
  • Introduction
  • Authorization
    • Authorization
    • Get access token
      POST
  • Beneficiaries
    • List all beneficiaries
      GET
    • Get beneficiary by ID
      GET
    • Create beneficiary
      POST
    • Update beneficiary
      PUT
  • Cards
    • Cards API
    • Get all cards
      GET
    • Create a new card
      POST
    • Get card by ID
      GET
    • Update card status
      PATCH
    • Replace or renew card
      POST
    • Generate card secret
      POST
  • Card Programs
    • Card Programs API
    • Get all programs
      GET
    • Create a new program
      POST
    • Get program by ID
      GET
  • Clients
    • Clients API
    • Get all clients
      GET
    • Get client by ID
      GET
    • Create a new client
      POST
    • Update client status
      PATCH
  • Endusers
    • Endusers API
    • Get all endusers
      GET
    • Create a new enduser
      POST
    • Get enduser by ID
      GET
  • Transactions
    • Transactions API
    • Get all transactions
    • Create a transaction
    • Get transaction by ID
    • Create manual credit transaction
    • Create manual debit transaction
  • Wallets
    • Wallets API
    • Get all wallets
    • Create a new wallet
    • Get wallet by ID
    • Update wallet
  • Relays
    • Relays API
    • Create subscription
  • Webhooks
    • Webhooks API
    • Get all webhooks
    • Create a webhook
    • Delete a webhook
  1. Beneficiaries

List all beneficiaries

GET
/customers/v1/beneficiaries

Request

None

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/customers/v1/beneficiaries'

Responses

🟢200Success
application/json
Body
array of:
id
string 
required
account_number
string 
required
bank_code
string 
required
bank_code_type
enum<string> 
required
Allowed values:
BSBBPAYROUTING_NUMBER
bank_country
string 
required
bank_name
string 
required
created_at
string <date-time>
required
metadata
object 
required
email
string 
required
updated_at
string <date-time>
required
status
enum<string> 
required
Allowed values:
ACTIVEINACTIVE
person
object 
required
name
string 
required
Example
[
    {
        "id": "string",
        "account_number": "string",
        "bank_code": "string",
        "bank_code_type": "BSB",
        "bank_country": "string",
        "bank_name": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "metadata": {
            "email": "string"
        },
        "updated_at": "2019-08-24T14:15:22Z",
        "status": "ACTIVE",
        "person": {
            "name": "string"
        }
    }
]
Previous
Get access token
Next
Get beneficiary by ID
Built with