Get Transfer by Reference

This endpoint returns the current status of a transfer. Use it to check a transaction status.

Environment	Method	URL
Development	GET	https://devo.finnet.co.id/was-adapter/transfer/get-reference
Production	GET	https://{tbc}/was-adapter/transfer/get-reference

Header Request

Name	Type	Mandatory	Description
Authorization	String	M	Represents Basic Authentication. e.g. Basic dW5kZWZpbmVkOnBhc3N3b3Jk
accept	String	M	Mandatory header to specify the response format. Must be set to application/json so the server returns the response in JSON format.

Body Request

No	Name	Type	Mandatory	Min Length	Max Length	Description
1	reference	string	Yes		255	Unique transfer reference set when the request was created

Sample Request

curl --request GET \
  --url https://api.finpay.co/get/transfers/reference=123456 \
  --header 'accept: application/json' \
  --header 'authorization: Basic {base64_encoded_api_key}'

Body Response

No	Name	Type	Mandatory	Min Length	Max Length	Description
1	created	string (date-time)	Yes		24	Timestamp when the transfer was created (ISO 8601)
2	transfer_id	string	Yes		36	Unique transfer ID from the Finnet system
3	reference	string	Yes		255	Unique transfer reference
4	source_user_id	string	Yes		36	Source user ID (master or sub-account)
5	destination_user_id	string	Yes		36	Destination user ID (master or sub-account)
6	status	string	Yes		–	Transfer status
						Valid values: SUCCESSFUL, PENDING, FAILED
7	amount	number	Yes		–	Amount transferred

Sample Response

{
  "created": "2020-11-30T02:47:53.061Z",
  "transfer_id": "bd1cc56b-ce7f-4ad7-8901-3eaa689e90eb",
  "source_user_id": "5cafeb170a2b18519b1b8768",
  "destination_user_id": "5f8d0c0603ffe06b7d4d9fcf",
  "status": "SUCCESSFUL",
  "amount": "90000",
  "reference": "Monthly_Transfers_1234"
}

Sample Response (Negative)

{
    "error_code": "DATA_NOT_FOUND",
    "message": "Could not find transfer by reference 00000000000000007. Please try again using valid reference"
}

Get Transfer by Reference HTTP Status Code

No	HTTP Status Code	Description
1	200	Success with Response Body Message
2	400	[ DESTINATION_ACCOUNT_NOT_FOUND, DATA_NOT_FOUND, CALLBACK_AUTHENTICATION_TOKEN_NOT_FOUND_ERROR ]
3	404	[ INVALID_API_KEY ]