Create Transfer
The Transfers API lets you move balances:
Between a master account and its sub-accounts (both directions)
Between sub-accounts
Use this to manage funds and split payments inside the Finnet ecosystem.
Header Request
Authorization
String
M
Represents Basic Authentication.
e.g. Basic dW5kZWZpbmVkOnBhc3N3b3Jk
Content-Type
String
M
Request body content type, e.g. application/json
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
1
reference
String
M
1
255
Unique transfer reference specified when the request is created
2
amount
Number
M
Transfer amount
3
source_user_id
String
M
1
36
User ID as the transfer source (master or sub-account)
4
destination_user_id
String
M
1
36
User ID as the transfer destination (master or sub-account)
Sample Request
Content-type: application/json
Authorization: Basic gp9HjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a"
accept: application/json
{
"reference": "string",
"amount": 1,
"source_user_id": "string",
"destination_user_id": "string"
}Body Response
1
created
string (date-time)
24
Timestamp when the transfer was created (ISO 8601)
Yes
2
transfer_id
string
36
Unique transfer reference generated by the Finnet system
Yes
3
reference
string
255
Unique transfer reference provided in the request
Yes
4
source_user_id
string
36
Source user ID (master or sub-account)
Yes
5
destination_user_id
string
36
Destination user ID (master or sub-account)
Yes
6
status
string
–
Transfer status. Valid values: SUCCESSFUL, PENDING, FAILED
Yes
7
amount
number
–
Transferred amount
Yes
Sample Response
Sample Response (Negative)
Create TransferStatus
1
SUCCESSFUL
Transfer completed
2
PENDING
Transfer is still being processed
3
FAILED
Transfer failed
Create Transfer HTTP Status Code
1
200
Success with response body
2
400
[ API_VALIDATION_ERROR, INVALID_CONFIGURATION, INVALID_JSON_FORMAT, TYPE_AND_CONFIGURATION_CONFLICT, INVALID_SOURCE_OR_DESTINATION_ERROR, INSUFFICIENT_BALANCE, INVALID_FEE_AMOUNT, DUPLICATE_ERROR, INVALID_AMOUNT, INSUFFICIENT_ACCOUNT_HOLDER_DATA, MISMATCH_PAYLOAD_FOR_REFERENCE, INVALID_URL_FORMAT ]
3
401
[ `INVALID_API_KEY` ]
4
403
[ REQUEST_FORBIDDEN_ERROR, FEATURE_NOT_ACTIVATED, DUPLICATE_REFERENCE, XEN_PLATFORM_SUB_ACCOUNT_NOT_LIVE, API_KEY_ENVIRONMENT_NOT_MATCH, CHANNEL_ACTIVATION_IN_PROGRESS, CHANNEL_HAS_BEEN_ACTIVATED, KYC_VERIFICATION_IN_PROGRESS ]
5
425
[ TRANSFER_IN_PROGRESS ]
Last updated

