Create a Transfer Request

Single - One way money movement between platform accounts

Method and URL

POST | [BASE_URL]/v1/transfers

Request

Example Body Request Payload

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

Request Body Schema

Schema Path	Description	Specifications
referenceId	Id of transaction reference from merchant, It can be used for reconcile process	Required Limited Special Character Allowed
recipientId	Id of the Recipient, in platform cases means merchantId	Required
amount	Transfer amount	Required
remarks	Note for the transaction	Required

Response

Example Response Body

{
    "code": "string",
    "message": "string",
    "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"
    }
}

Response Data Schema

Schema Path	Description	Data Type Validation
code	Response Code from Pivot	String
message	Human readable message that represent response from Pivot	String
data	Response Data from Pivot contains Transfer Object	Object