get https://api.getpinch.com.au/test/payments/
The payment object represents a single payment, however there can be multiple attempts at trying to complete the transaction. This means that if a payment fails (aka is dishonoured) you can re-attempt it until it succeeds. This is handy for keeping track of payment attempts in one place, however you're more than welcome to create a brand new payment, instead of re-attempting a failed one.
| Attribute | Description |
|---|---|
| id string | The payment ID. Payments are prefixed with "_pmt". |
| payerId string | The payer's ID |
| amount integer | The payment amount in cents |
| transactionDate date | The date the transaction was attempted |
| description string | An optional description of the payment. This will be visible to the payer. |
| status string | The current status of the payment. Will be one of: - scheduled - the payment is waiting to be attempted - processing - the payment has been sent to the bank and is now awaiting clearance (can take up to 7 days) - dishonoured - the payment was dishonoured by the payer's bank - transferred - the payment amount has successfully been transferred to you |