WePay logo
      Nothing Found

Create a pad agreement

post/pad_agreements

The POST /pad_agreements call allows your platform to create a Pre-Authorized Debit (PAD) agreement. A PAD agreement is an agreement between a customer and a biller. This is used for CAD eCheck payments only.

SecurityappIdAuth and appTokenAuth
Request
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.

Request Body schema: application/json
payment_method_id
required
string^[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}...
account_id
required
string^[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}...
category
required
string
Enum: Description
personal

Used for personal activities such as rent, mortgage etc. The payer is a consumer.

business

Used for a business' activities such as supplies, lease etc. The payer is a company.

… 2 more
type
required
string
Enum: Description
one_time

Debits that are authorized for a single one-time transaction.

recurring

Debits that are set to be made at specific intervals.

… 1 more
required
object
Responses
201
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, MERCHANT_ACCOUNT_CANNOT_ACCEPT_PAYMENTS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples
application/json
{
  • "payment_method_id": "00000000-6261-4341-0000-00000000165d",
  • "account_id": "6ffd8784-7047-4c1e-b2c8-cce195f83b20",
  • "category": "personal",
  • "type": "sporadic",
  • "signature": {
    • "signatory_name": "abc",
    • "signature_time": 1657052022
    }
}
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": false,
  • "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"
}