get https://api.getpinch.com.au/test/payers/
A payer is someone who you are going to debit. It stores basic information about the person and also their bank details.
id string | The ID of the payer. Payers are always prefixed with "pyr_" |
firstName string | First Name |
lastName string | Last Name |
emailAddress string | Email Address |
bsb string | The BSB of the payer's bank account. This should be 6 digits (without dashes or spaces). |
accountNumber string | The Account Number of the payer's bank account. This should be between 3 and 11 digits long. |
accountName string | The Account Name of the payer's bank account |
agreements Array of Agreement | A list of agreements for the current Payer. An agreement represents a contract between the Payer and Pinch to allow for direct debiting of their bank account. Also known as a Direct Debit Request or DDR. |
Agreement
id string | The Id for the agreement. Prefixed with "agr_". |
anonymousViewToken string | Allows the user to access the PDF copy of the contract anonymously for a short period of time. |
agreementDateUtc date | The date that the agreement contract was generated. |
confirmedDateUtc date | The date that the user confirmed and agreed to the agreement contract. |