Create Account
Create Account API allows you to create Sub-Accounts for your Partners on your Platform. Once an Account is created, you can accept and route payments through the Transfers API or Platform Fee API
Header Request
Authorization
String
M
Represents Basic Authentication.
e.g. Basic dW5kZWZpbmVkOnBhc3N3b3Jk
Content-Type
String
M
Content of you request body 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
String
M
5
552
Email address to be registered as the account.
e.g.kirana@finpay.id
2
type
String
M
1
15
Type of account to be created.
e.g. "OWNED"`
Valid values: [ MANAGED, OWNED]
3
public_profile
Object
M
Detail of Public profile account
4
public_profile.business_name
String
M
1
512
Business name to be displayed.
e.g.Owned Business Account
Sample Request
Content-type: application/json
Authorization: Basic gp9HjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a"
accept: application/json
{
"email": "kirana@finpay.id",
"type": "OWNED",
"public_profile": {
"business_name": "Owned Business Account"
}
}
Body Response
1
id
String
M
1
36
Unique identifier of the data
2
created
String(ISO 8601)
M
24
24
Date and time when the data was created
3
updated
String(ISO 8601)
M
24
24
Date and time when the data was last updated
4
type
String
M
5
20
Type of account to be created.
e.g. OWNED`
Valid values: [ MANAGED, OWNED]
5
Number
M
5
552
Email address to be registered as the account.
e.g.kirana@finpay.id
6
public_profile
Object
M
-
-
Detail of Public profile account
7
public_profile.business_name
String
M
1
512
Business name to be displayed.
e.g.Owned Business Account
8
country
String
M
2
2
Country code (ISO 3166-1 alpha-2, e.g. ID)
Sample Response
Sample Response (Negative)
Create Account Status
1
REGISTERED
Merchant has registered using the invited email address
2
AWAITING_DOCS
N/A
3
LIVE
Merchant is able to transact (Active)
4
SUSPENDED
Merchant is blocked
5
INVITED
Merchant has just submitted the registration
Create Account HTTP Status Code
1
200
Success with Response Body Message
2
400
error_code: API_VALIDATION_ERROR
error_message: Inputs are failing validation. The errors field contains details about which fields are violating validation
3
400
error_code: INVALID_CONFIGURATION
error_message: The `configurations` parameter combination is invalid. Please follow the requirement of each parameter written in Request section
4
400
error_code: TYPE_AND_CONFIGURATION_CONFLICT
error_message: Please provide either one of the `type` field or the `configurations` field
Last updated