Create a Transfer

Single - One way money movement between platform accounts

Method and URL

POST [BASE_URL]/v1/transfers

Request

Request Body

{
    "referenceId": "PAY/trf-0109332",
    "recipientId": "u734-981324saf-53tup",
    "transferType": "DIRECT",
    "amount": 10000,
    "remarks": "transfer for coffeeshop"
}

Detail Parameter Request

Parameter	Data Type	Character limit	Requirement	Description
referenceId	String	1-100	M	Id of transaction reference from merchant, It can be used for reconcile process
recipientId	Uuid	-	M	Id of the Recipient, in platform cases means merchantId
transferType	String	0-20	M	Posibble value is DIRECT
amount	Numeric	-	M	Transfer amount
remarks	String	1-100	M	Note for the transaction

Response

Response Body

{
    "code": "00",
    "message": "Success",
    "data": {
        "uuid": "8uh7-n332-9vst-l2c1",
        "recipientId": "u734-981324saf-53tu",
        "amount": 10000,
        "remarks": "transfer for coffeeshop",
        "status": "SUCCESS",
        "transaction_timestamp": "2024-05-13T08:21:44.967496538Z",
        "created": "2024-05-13T08:21:44.967496538Z",
        "updated": "2024-05-13T08:21:44.967496538Z"
    }
}

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 Transfer Object