Update a PAD by its ID.

put

https://api.helcim.com/v2/customers/{customerId}/bank-accounts/{bankAccountId}/pads/{padId}

Path Params

customerId

number

required

Customer ID.

bankAccountId

number

required

Bank account ID.

padId

number

required

PAD ID.

Body Params

Optional PAD fields to be updated.

accepted

int8

enum

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.

Allowed:

ipAddress

string

type

int8

enum

The type of the bank account:

1 - Personal
2 - Business

Allowed:

status

int8

enum

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.

Allowed:

Responses

200

Successfully updated PAD.

403

User does not have valid permissions.

500

Unexpected internal error.

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Invalid request.