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.

info

Unlike transaction activity reports and statements, payment confirmations are returned synchronously — the PDF is included directly in the response body and downloaded to your machine immediately. No email is sent.

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.

info

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.

Sample requestRequest structure

Copy

Copied

curl -i -X GET \
  'https://api.equalsmoney.com/payments/12345/confirmation?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Copy

Copied

curl -i -X GET \
  '{{https://api.equalsmoney.com/payments/{paymentId}/confirmation?accountId={accountId}}}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Request parameters

Path parameters

Parameter	Description
`paymentId` integer required	The ID of the payment for which you're downloading the confirmation. Allowable values: An existing `paymentId` (>= 1)

Query parameters

Parameter	Description
`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.

Common errors

HTTP status	Cause	Resolution
`400`	Invalid `paymentId` or `accountId`	Ensure both parameters are valid and the payment belongs to the specified account.
`401`	Missing or invalid API key	Ensure the `Authorization` header uses the format `ApiKey YOUR_API_KEY_HERE`.
`403`	IP not whitelisted	Contact your account manager to whitelist your IP address.
`404`	Payment not found	Verify that the `paymentId` exists and is associated with your account.