Update Payout Beneficiary

PATCH

/api/v1/payout-beneficiary/update/{payout_beneficiary_id}

This API is used to update details of an individual Payout beneficiary using the payout_beneficiary_id

Each POST/PATCH Request requires a Signature in the header, you can follow the following code to create the Signature:

const signature = cryptoJs.HmacSHA256(
    cryptoJs.enc.Utf8.parse(JSON.stringfy(body)),
    cryptoJs.enc.Utf8.parse(signatureKey)
).toString();

Request

Path Params

payout_beneficiary_id

string

required

Header Params

X-token

string

required

signature

string

required

Hash your string payload request using SHA256, and use your SignatureKey as key

Body Params application/json

type

string

required

company

object

optional

address_city

string

optional

address_country

string

optional

address_line1

string

optional

address_line2

string

optional

address_state

string

optional

address_zip_code

integer

optional

company_email

string

optional

incorporation_country

string

optional

name

string

required

phone_country_code

string

optional

phone_number

string

optional

registration_number

string

optional

individual

object

optional

address_city

string

optional

address_country

string

optional

address_line1

string

optional

address_line2

string

optional

address_state

string

optional

address_zip_code

string

optional

country_of_residence

string

optional

dob

string

optional

string

optional

first_name

string

required

last_name

string

required

identification_custom_type

string

optional

identification_type

string

optional

identification_value

string

optional

nationality

string

optional

phone_country_code

string

optional

phone_number

string

optional

aba

string

optional

account_number

string

optional

bank_code

string

optional

bank_country

string

optional

bank_name

string

optional

beneficiary_name

string

required

bic_swift

string

optional

intermediary_bic_swift

string

optional

branch_code

string

optional

bsb

string

optional

currency

string

optional

description

string

optional

iban

string

optional

ifsc

string

optional

organization_reference_id

string

optional

pay_id

string

optional

pay_id_type

string

optional

sort_code

string

optional

proxy_type

string

optional

proxy_value

string

optional

metadata

object

optional

Example

{
  "type": "company",
  "company": {
    "address_city": "string",
    "address_country": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_state": "string",
    "address_zip_code": 0,
    "company_email": "string",
    "incorporation_country": "string",
    "name": "string",
    "phone_country_code": "string",
    "phone_number": "string",
    "registration_number": "string"
  },
  "individual": {
    "address_city": "string",
    "address_country": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_state": "string",
    "address_zip_code": "string",
    "country_of_residence": "string",
    "dob": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "identification_custom_type": "string",
    "identification_type": "string",
    "identification_value": "string",
    "nationality": "string",
    "phone_country_code": "string",
    "phone_number": "string"
  },
  "aba": "string",
  "account_number": "string",
  "bank_code": "string",
  "bank_country": "string",
  "bank_name": "string",
  "beneficiary_name": "string",
  "bic_swift": "string",
  "intermediary_bic_swift": "string",
  "branch_code": "string",
  "bsb": "string",
  "currency": "string",
  "description": "string",
  "iban": "string",
  "ifsc": "string",
  "organization_reference_id": "string",
  "pay_id": "string",
  "pay_id_type": "string",
  "sort_code": "string",
  "proxy_type": "string",
  "proxy_value": "string",
  "metadata": {}
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.paycombat.com/api/v1/payout-beneficiary/update/' \
--header 'X-token;' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "company",
    "company": {
        "address_city": "string",
        "address_country": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_state": "string",
        "address_zip_code": 0,
        "company_email": "string",
        "incorporation_country": "string",
        "name": "string",
        "phone_country_code": "string",
        "phone_number": "string",
        "registration_number": "string"
    },
    "individual": {
        "address_city": "string",
        "address_country": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_state": "string",
        "address_zip_code": "string",
        "country_of_residence": "string",
        "dob": "string",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "identification_custom_type": "string",
        "identification_type": "string",
        "identification_value": "string",
        "nationality": "string",
        "phone_country_code": "string",
        "phone_number": "string"
    },
    "aba": "string",
    "account_number": "string",
    "bank_code": "string",
    "bank_country": "string",
    "bank_name": "string",
    "beneficiary_name": "string",
    "bic_swift": "string",
    "intermediary_bic_swift": "string",
    "branch_code": "string",
    "bsb": "string",
    "currency": "string",
    "description": "string",
    "iban": "string",
    "ifsc": "string",
    "organization_reference_id": "string",
    "pay_id": "string",
    "pay_id_type": "string",
    "sort_code": "string",
    "proxy_type": "string",
    "proxy_value": "string",
    "metadata": {}
}'

Responses

🟢200Success

application/json

Body

status

boolean

required

message

string

required

data

object

required

aba

string

required

account_number

string

required

bank_code

string

required

bank_country

string

required

bank_name

string

required

beneficiary_name

string

required

bic_swift

string

required

intermediary_bic_swift

string

required

branch_code

string

required

bsb

string

required

company

object

required

created_at

string

required

created_by

string

required

currency

string

required

description

string

required

iban

string

required

ifsc

string

required

is_active

boolean

required

metadata

object

required

org_id

string

required

organization_reference_id

string

required

pay_id

string

required

pay_id_type

string

required

payout_beneficiary_id

string

required

proxy_type

string

required

proxy_value

string

required

sort_code

string

required

type

string

required

updated_at

string

required

Example

{
  "status": true,
  "message": "string",
  "data": {
    "aba": "string",
    "account_number": "string",
    "bank_code": "string",
    "bank_country": "string",
    "bank_name": "string",
    "beneficiary_name": "string",
    "bic_swift": "string",
    "intermediary_bic_swift": "string",
    "branch_code": "string",
    "bsb": "string",
    "company": {
      "address_city": "string",
      "address_country": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_zip_code": 0,
      "company_email": "string",
      "company_incorporation_country": "string",
      "name": "string",
      "phone_country_code": "string",
      "phone_number": "string",
      "phone_number_e164": "string",
      "registration_number": "string",
      "identification_type": "string",
      "identification_value": "string"
    },
    "created_at": "2024-12-26T10:49:05.333Z",
    "created_by": "string",
    "currency": "string",
    "description": "string",
    "iban": "string",
    "ifsc": "string",
    "is_active": true,
    "metadata": {},
    "org_id": "string",
    "organization_reference_id": "string",
    "pay_id": "string",
    "pay_id_type": "string",
    "payout_beneficiary_id": "string",
    "proxy_type": "string",
    "proxy_value": "string",
    "sort_code": "string",
    "type": "string",
    "updated_at": "2024-12-26T10:49:05.333Z"
  }
}

🟠400Bad Request

Modified at 2025-04-15 07:28:29

Create Payout Beneficiary

Get All Payout Beneficiary