Transfer Object

A transfer is single money movement between account inside the platform

{
  "uuid": "8uh7-n332-9vst-l2c1",
  "referenceId": "[your_reference]",
  "recipientId": "u734-981324saf-53tu",
  "amount": 100000,
  "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"
}

Transfer Object Schema

Schema Path	Specs and Validation	Description
uuid	String	Object Unique Identifier
referenceId	String Required	Merchant Reference Id from the Client's System
recipientId	String Required	UUID of the Recipient, recipient can be a merchant for platform case or a customer for wallet case
amount	Number Required	Transfer amount
remarks	String Required	Transfer note or remarks from the Client's System
transferType
status	ENUM Generated	Transfer Status, one of SUCCESS, PENDING and FAILED
transactionTimestamp	String Generated	Transfer transaction timestamp
created	String Generated	Transfer Object created time in ISO-8601 Format. i.e. 2024-05-13T08:21:44.967496538Z
updated	String Generated	Transfer Object last updated time in ISO-8601 Format. i.e. 2024-05-13T08:21:44.967496538Z