Skip to main content

​
Payment confirmation

Download a PDF confirmation for a specific payment. A payment confirmation includes details about the remitting account, the transfer (including its status), the recipient, and the payment itself.

​
Download a payment confirmation PDF

GET /payments/{paymentId}/confirmation

​
Request

Use this request to download a PDF confirmation of a payment. The PDF includes comprehensive details about the payment transaction, including account information, payment status, recipient details, and transfer information.
If you need a comprehensive view of all transaction activity across your accounts, you can download a transaction activity report in CSV format instead.
You must provide the payment ID and account ID to retrieve the confirmation.

​
Request parameters

Path parameters
​
paymentId
integer
required
The ID of the payment for which you’re downloading the confirmation.Allowable values: An existing paymentId (>= 1)
Query parameters
​
accountId
string
required
The ID of the account associated with the payment.Allowable values: An existing accountId (e.g., F50091)

​
Response

If your request is successful, you’ll receive a 200 response with the payment confirmation PDF file. The PDF includes:
  • Remitting account details
  • Transfer information and status
  • Recipient details
  • Payment details
For more information about this request and its response, see the API reference.