Get Payout Receipt infos

Get Payout Receipt infos

Returns the necessary data to build a custom payment receipt page. This endpoint provides only structured information (JSON) so you can implement the visual interface according to your system's design.

Typical Usage

1. Call this endpoint when the user requests to view the receipt

2. Use the returned data to populate your custom interface

3. Offer the user the option to download the official PDF (using Generate Payout Receipt)

GET {{Environment_URL}}/mass-payments/v1/payouts/:id/proof-of-payment

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

Get proof of payment infos

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

Response

201 - Success

{
  "id": "b4977f11-ebba-4709-b5dd-0bd5d06b99bb",
  "amount": 1,
  "paidIn": "2025-11-06T18:52:35.064Z",
  "name": "John Doe",
  "endToEndId": "E132033542025110621527779801D319",
  "bankDetails": {
    "accountHolderDocument": "775.***.709-**",
    "bankBranch": "0238",
    "bankName": "ID20",
    "bankPspId": "ID20",
    "bankNumber": "ID20",
    "accountNumber": "318183",
    "accountDigit": null
  },
  "pixType": "UNKNOWN",
  "pixKey": "77*******00"
}