Private API Reference

Proof of Authorization Requests

A request for proof of authorization for one or more ACH debit transfers.

Events

Your application can listen to webhooks about this resource. The events about Proof of Authorization Requests will have the categories "proof_of_authorization_request.created" or "proof_of_authorization_request.updated" .

The Proof of Authorization Request object

{
  "ach_transfers": [
    {
      "id": "ach_transfer_uoxatyh3lt5evrsdvo7q"
    }
  ],
  "created_at": "2020-01-31T23:59:59Z",
  "due_on": "2020-01-31T23:59:59Z",
  "id": "proof_of_authorization_request_iwp8no25h3rjvil6ad3b",
  "type": "proof_of_authorization_request",
  "updated_at": "2020-01-31T23:59:59Z"
}

Attributes

ach_transfers

array

The ACH Transfers associated with the request.

created_at

string

The time the Proof of Authorization Request was created.

due_on

string

The time the Proof of Authorization Request is due.

string

The Proof of Authorization Request identifier.

type

string

A constant representing the object’s type. For this resource it will always be proof_of_authorization_request.

updated_at

string

The time the Proof of Authorization Request was last updated.

List Proof of Authorization Requests

curl \
  --url "${INCREASE_URL}/proof_of_authorization_requests" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* Proof of Authorization Request object */ },
    { /* Proof of Authorization Request object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

More parameters

cursor

string

limit

integer

created_at.after

string

created_at.before

string

created_at.on_or_after

string

created_at.on_or_before

string

Retrieve a Proof of Authorization Request

curl \
  --url "${INCREASE_URL}/proof_of_authorization_requests/proof_of_authorization_request_iwp8no25h3rjvil6ad3b" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

proof_of_authorization_request_id

string

Required

The identifier of the Proof of Authorization Request.