Kobble

Create beneficiary

POST

/customers/v1/beneficiaries

Request

Body Params application/json

bank_name

string

required

bank_country

string <char>

required

ISO 3166-1 Alpha-3 Country Code

>= 3 characters<= 3 characters

Example:

SGP

Match pattern:

^[A-Z]{3}$

bank_code_type

enum<string>

required

Allowed values:

BSBBPAYROUTING_NUMBERSORT_CODE

bank_code

string

required

account_number

string

required

person

object

optional

name

string

required

company

object

optional

name

string

required

metadata

object

optional

Example

{
    "bank_name": "Westpac",
    "bank_country": "AUS",
    "bank_code_type": "BSB",
    "bank_code": "111-111",
    "account_number": "05293193",
    "person": {
        "name": "Mike Smith"
    },
    "metadata": {}
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/customers/v1/beneficiaries' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bank_name": "Westpac",
    "bank_country": "AUS",
    "bank_code_type": "BSB",
    "bank_code": "111-111",
    "account_number": "05293193",
    "person": {
        "name": "Mike Smith"
    },
    "metadata": {}
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Get beneficiary by ID

Update beneficiary