Collections

Operations related to Collections

📄️ Refresh payment session

Refreshes the payment session token and returns the updated payment request. A refreshed payment session grants 1 hour to view and complete the payment. This endpoint is only applicable for payment requests with an execution mode of HOSTED_PAGE and a status of UNPAID or PART_PAID. If the request does not meet these criteria, a bad request will be returned.

📄️ Get a payer by ID

Get a payer by ID

📄️ Update payer

Overwrites the existing payer with the provided details

📄️ List payment requests

List all payment requests for an account

📄️ Create payment request

Create payment request

📄️ List payers

List all payers for an account

📄️ Create payer

Create payer

📄️ Upload document

Stores a document used for payment requests (e.g. for RFIs)

📄️ Get Exchange rates

Use the Get Exchange rates endpoint to retrieve indicative exchange rates for a specific collection type

📄️ Get a payment request by ID

Retrieve a single payment request by id

📄️ Get a list of payments

Get a list of payments for a payment request

📄️ Get a specific payment

Get a specific payment under a payment request