Generate Payout Receipt

Generate Payout Receipt

Generates or retrieves the official payout receipt in PDF format for a specific payout. The document follows the system’s standard layout and includes all legally required information to validate the transaction.

💡Important: After the first generation, store the url locally. The receipt is immutable, any future requests will always return the same file.

POST {{Environment_URL}}/mass-payments/v1/payouts/:id/proof-of-payment/export/pdf

Headers

Name	Value
Authorization	Bearer <token>

Path Params

Key	Description	Required?	Data type	Example value
payout_id	payout identifier.	true	String	"f384007d-535b-465d-8302-a59e8fb24485"

Example Request

Generate Payout Receipt

curl --location -g --request POST '{{Environment_URL}}/mass-payments/v1/payouts/b4977f11-ebba-4709-b5dd-0bd5d06b99bb/proof-of-payment/export/pdf' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbFFpbCI6ImdvdGNoYUBkZFYuY29tIiwibmFtZSI6IjV0MWxsNXVwM3I1dHIwbmdQFDU1dzByZCJ9.Fn_ndMxAmiFYFR99vIxt16uFf5e7agZ2eD_fbmt-LGw'

Response

201 - Success

{
  "id": "b4977f11-ebba-4709-b5dd-0bd5d06b99bb",
  "url": "https://simple-wl-demo.s3.amazonaws.com/b4977f11-ebba-4709-b5dd-0bd5d06b99bb.pdf"
}