WePay logo
      Nothing Found

GET a list of pad agreements

get/pad_agreements

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

SecurityappIdAuth and appTokenAuth
Request
query Parameters
payment_method_id
string

The payment method ID associated with the PAD agreement.

account_id
string

The payment method ID associated with the PAD agreement.

revoked
boolean

Revoke status of the PAD agreement.

type
string

The type of PAD agreement.

page
string

Returns elements starting from this page. If specified, no other query parameters can be specified.

page_size
integer [ 1 .. 50 ]
Default: 10

Maximum number of items per page of results.

header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
next
required
string or null
previous
required
string or null
api_version
required
string
required
Array of objects unique
400

INVALID_PARAMS, MERCHANT_ACCOUNT_CANNOT_ACCEPT_PAYMENTS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "next": "/pad_agreements?page=QVFQNUFBRVgzVDMrd3Rxd2RPYThkbFhtLzJUa08rMkU0djJnUHNpNk1HUlVhc2NoTWowUFFCaVNzajY5K1VLNFdSQ056Q1ZqL25qQXVZSDlLNVZXUnIvYVFOOTBCc2lSMWxOKzIrNzJxWXNWN1VhSHkvWllmcXF2NkNMZEphdXZYVlo3OHZtZkYzaVcwaEtpelRDbytUQjVDQ3lxUmxxSDVyaUJ4TUQwTGt1NTBwTW5qZlMvZmk1Q1paUDJJN1VPbDRpVjNxVWFDUTNZVi9aQTN3ZkJLYmtQOGpOMCtqeUJBOTNmQjcyKzczRHM1VkNHelJRMWRQLzNoNFJ0WWQxLw==",
  • "previous": null,
  • "api_version": "3.2",
  • "results": [
    • {
      • "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"
      },
    • {
      • "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-000000000444",
      • "resource": "pad_agreements",
      • "path": "/pad_agreements/00000000-0000-0000-0000-000000000444",
      • "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"
      }
    ]
}