Get Payout by ID

API to retrieve a payout by its ID.

Environment	Method	URL Path	Version
Development	GET	https://... /payout/{payout_id}	V 1.0.0
Production	GET	https://... /payout/{payout_id}	V 1.0.0

Request

Request headers

No	Name	Type	Mandatory	Description
1	Authorization	String	M	Basic Authentication header. Example value: Basic dW5kZWZpbmVkOnBhc3N3b3Jk
2	accept	String	M	application/json
3	for-user-id	String	M	Subaccount user ID that this request is for

Request body

No	Name	Type	Mandatory	Min Length	Max Length	Description
1	payout_id	string	M		29	Unique payout ID from the system

Sample request

curl --request GET \
  --url 'https://api.finpay.id/payout/disb-571f3644d2b4edf0745e9703' \
  --header 'accept: application/json' \
  --header 'authorization: Basic YXNkYXNkOnBhc3N3b3Jk' \
  --header 'for-user-id: 692e8e678ed4264955161b61'

Response

Response body

No	Name	Type	Mandatory	Min Length	Max Length	Description
1	id	String	M			Unique identifier of the payout transaction (generated by the system).
2	amount	Number	M			Amount being transferred.
3	channel_code	String	M			Destination bank or e-wallet code (example: ID_BCA).
4	currency	String	M			Currency code in ISO 4217 format (example: IDR).
5	status	String	M			Current transaction status (example: ACCEPTED, SUCCEEDED).
6	description	String	O			Additional payout note/description.
7	reference_id	String	M			Merchant unique reference ID used for reconciliation.
8	created	String	M			Request creation timestamp (ISO 8601).
9	updated	String	M			Last status update timestamp (ISO 8601).
10	estimated_arrival_time	String	O			Estimated time the funds will arrive (ISO 8601).
11	business_id	String	M			Merchant business ID (account owner).
12	channel_properties	Object	M			Object containing destination account details.
13	channel_properties.account_number	String	M			Destination account number.
14	channel_properties.account_holder_name	String	O			Destination account holder name (as per bank records).

Sample response

{ 
  "id": "disb-571f3644d2b4edf0745e9703", 
  "amount": 10000, 
  "channel_code": "ID_BCA", 
  "currency": "IDR", 
  "status": "ACCEPTED", 
  "description": "July payout", 
  "reference_id": "myref-1482928194", 
  "created": "2024-12-31T23:53:59Z", 
  "updated": "2024-12-31T23:53:59Z", 
  "estimated_arrival_time": "2024-12-31T23:59:59Z", 
  "business_id": "6018306aa16ad90cb3c43ba7", 
  "channel_properties": { 
    "account_number": "000000000099", 
    "account_holder_name": "Michael Chen" 
  } 
} 

Sample response (error)

{ 
    "error_code": "DATA_NOT_FOUND", 
    "message": "Could not find payout with the corresponding ID. Please try again with a valid Id"
} 

Response Code

No	Response Code	Response Code Description	Description
1	401	INVALID_API_KEY	API key format is invalid
2	404	DATA_NOT_FOUND	Could not find payout with the corresponding ID. Please try again with a valid Id
3	500	SERVER_ERROR	Error connecting to our server. Retry safely using Idempotency-key header when available