HEhelcim
Customer

Update a PAD by its ID.

put/customers/{customerId}/bank-accounts/{bankAccountId}/pads/{padId}

Request

  • Base URL
    https://api.helcim.com/v2
  • URL
    https://api.helcim.com/v2/customers/{customerId}/bank-accounts/{bankAccountId}/pads/{padId}
  • Auth
    API key in header api-token

Path parameters

customerIdnumber required

Customer ID.

bankAccountIdnumber required

Bank account ID.

padIdnumber required

PAD ID.

Request body

accepted0 | 1

Whether the PAD was accepted or not:

  • 0 - Unaccepted
  • 1 - Accepted

If the PAD is set to accepted and the PAD is active, a side effect of updating the associated bank account to ready will also happen. If the PAD was set to unaccepted, it will unready the bank account.

ipAddressstring
type1 | 2

The type of the bank account:

  • 1 - Personal
  • 2 - Business
status1 | 2

The status of the PAD:

  • 1 - Active
  • 2 - Inactive

If the PAD is set to active and the PAD is accepted, a side effect of updating the associated bank account to ready will also happen. If the PAD was unaccepted, it will unready the bank account. Note: there can only be 1 active PAD per bank account.

Example request

{
  "accepted": 1,
  "ipAddress": "123.456.789.0",
  "type": 2,
  "status": 1
}

Response

Successfully updated PAD.

Changes

No recorded changes to this operation across all 2 revisions of this API.