List of Transfer

Get a Collection of transfer details

Method and URL

GET [BASE_URL]/v1/transfers?referenceId={referenceId}

referenceId is optional.

With referenceId Provided, the response will return an array of data containing a single transfer with an exact match reference ID

Response

Response Body

{
    "code": "00",
    "message": "Success",
    "data": [
        {
            "uuid": "8uh7-n332-9vst-l2c1",
            "referenceId": "PAY/trf-0109332",
            "recipientId": "u734-981324saf-53tu",
            "amount": 10000,
            "remarks": "transfer for coffeeshop",
            "transferType": "DIRECT",
            "status": "SUCCESS",
            "transaction_timestamp": "2024-05-13T08:21:44.967496538Z",
            "created": "2024-05-13T08:21:44.967496538Z",
            "updated": "2024-05-13T08:21:44.967496538Z"
        },
        // more transfer items
    ],
    "pagination": {
        "page": 1,
        "perPage": 10,
        "totalPage": 10,
        "totalData": 100
    }
}

Detail Parameter Response

Parameter	Data Type	Requirement	Description
code	String	M	Response Code from Pivot
message	String	M	Human readable message that represent response from Pivot
data	Object	M	Response Data from Pivot contains list of Transfer Object
pagination	Object	M	Pagination