WePay logo
      Nothing Found

Revoke a pad agreement

post/pad_agreements/{id}/revoke

The POST /pad_agreements/{id}/revoke call allows your platform to revoke a single pad agreement.

SecurityappIdAuth and appTokenAuth
Request
path Parameters
id
required
string

The PAD agreement ID.

header Parameters
Api-Version
required
string
Example: 3.0
Content-Type
required
stringapplication/json
Example: application/json
Unique-Key
required
string
WePay-Risk-Token
string

This header is required when tokenizing Payment Methods, Legal Entities, and Payout Methods when the tokenization JS library is not being used.

Client-IP
string

This header is required when tokenizing Payment Methods, Legal Entities, and Payout Methods when the tokenization JS library is not being used.

Responses
200

good response

Response Schema: application/json
payment_method_id
required
string

ID of the payment method used, generated by WePay when the payment method is created.

account_id
required
string

Merchant's account ID associated with the PAD agreement.

category
required
string

Category of the PAD agreement.

type
required
string

Type of the PAD agreement.

required
object
revoked
required
boolean

Revoke status of the PAD agreement.

id
required
string

ID of the PAD agreement.

resource
required
string

Helps organize information by identifying the resource type of the object data.

Value: Description
pad_agreements

Helps organize information by identifying the resource type of the object data.

path
required
string

The HTTP path of the resource. The path can be used to retrieve details about the resource and perform actions on it.

create_time
required
integer <int64> >= 0

The UNIX timestamp for when the object was created.

required
object

Details the owner resource and owner path.

api_version
required
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "payment_method_id": "00000000-0000-0000-0000-000000000111",
  • "account_id": "00000000-0000-0000-0000-000000000222",
  • "category": "personal",
  • "type": "sporadic",
  • "signature": {
    • "signatory_name": "abc",
    • "signature_time": 1657052022
    },
  • "revoked": true,
  • "id": "00000000-0000-0000-0000-000000000333",
  • "resource": "pad_agreements",
  • "path": "/pad_agreements/00000000-0000-0000-0000-000000000333",
  • "create_time": 1657052022,
  • "owner": {
    • "id": "00000000-0000-0000-0000-000000000111",
    • "resource": "payment_methods",
    • "path": "/payment_methods/00000000-0000-0000-0000-000000000111"
    },
  • "api_version": "3.2"
}