Update payment information

curl --request PUT \
  --url https://api.cadanapay.com/v1/persons/{personId}/paymentInfo \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "preferredMethod": "ach",
  "ach": {
    "accountName": "John Doe",
    "accountNumber": "123456789",
    "bankName": "Gotham City Bank",
    "routingNumber": "000000000",
    "accountType": "Checking",
    "address": {
      "line1": "1234 Elm St",
      "line2": "Apt 1A",
      "city": "Gotham",
      "postalCode": "10001",
      "state": "NY",
      "countryCode": "US"
    }
  }
}
'

{
  "code": "invalid_request_body",
  "message": "The request body provided is not valid",
  "params": {
    "field": "Value is invalid."
  }
}

{
  "code": "resource_not_found",
  "message": "Requested resource could not be found."
}

{
  "code": "internal_error",
  "message": "An unexpected error occurred. Please try again later."
}

PUT

persons

{personId}

paymentInfo

curl --request PUT \
  --url https://api.cadanapay.com/v1/persons/{personId}/paymentInfo \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "preferredMethod": "ach",
  "ach": {
    "accountName": "John Doe",
    "accountNumber": "123456789",
    "bankName": "Gotham City Bank",
    "routingNumber": "000000000",
    "accountType": "Checking",
    "address": {
      "line1": "1234 Elm St",
      "line2": "Apt 1A",
      "city": "Gotham",
      "postalCode": "10001",
      "state": "NY",
      "countryCode": "US"
    }
  }
}
'

{
  "code": "invalid_request_body",
  "message": "The request body provided is not valid",
  "params": {
    "field": "Value is invalid."
  }
}

{
  "code": "resource_not_found",
  "message": "Requested resource could not be found."
}

{
  "code": "internal_error",
  "message": "An unexpected error occurred. Please try again later."
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey

string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

personId

string<uuid>

required

The unique identifier for the person

Body

application/json

Update person payment info request payload

preferredMethod

enum<string>

required

The preferred payment method type

Available options:

momo,

bank,

swift,

ach,

wallet,

wire

Example:

"bank"

momo

object

Show child attributes

bank

object

Show child attributes

swift

object

Show child attributes

ach

object

Show child attributes

wallet

object

Show child attributes

wire

object

Wire transfer payment details

Show child attributes

Response

Successful operation

Get payment information

Schedule offboarding

⌘I

Overview

Payments API

Wallets API

Workforce API

Tax API

Statutory Compliance API

Authorizations

Headers

Path Parameters

Body

Response