Create Wallet
Creates a digital wallet. The wallet creation processing is performed synchronously, and a response body with wallet information will be returned.
HTTP Request
POST
/v1/accounts/wallet
Request Headers{
"Content-Type": "application/json",
"Authorization": "Bearer {{access_token}}",
"x-api-key": "Your assigned api key"
}
Request Body{
"phoneNumber": "+855044946043",
"name": "Test one",
"country": "CO",
"currency": "COP",
"groupId": "0001",
"idempotencyKey": "65e85d27-1677-4a98-9f6e-dd03cfa07ea3"
}
Content-Type: application/json{
"id": "cde5843c-bbd0-46d2-9fbb-27b08f3ad021",
"balanceInCents": 0,
"status":"ACTIVE",
"groupId": "0001",
"country": "CO",
"currency": "COP"
}
Content-Type: application/json{
"errors": [
{
"code": "400",
"errorMessage": "Invalid request field: phoneNumber: Invalid Phone Number"
}
]
}
Key |
Value |
Content-Type |
application/json |
Authorization |
Bearer {{access_token}} |
x-api-key |
Your assigned api key |
Request Body Parameters
Parameter |
Required |
Type |
Description |
phoneNumber |
|
String |
Wallet holder phone number, with both country code and national number. Format as "+" + "country code" + "national number", <=20 characters. |
name |
|
String |
Wallet holder full name |
country |
|
String |
Wallet holder country code, such as CO for Colombia. |
currency |
|
String |
Currency code (ISO 4217) used for wallet holder , such as COP for Colombia. |
groupId |
|
String |
The group id/name that wallet holder belongs to, <= 64 characters. |
idempotencyKey |
|
String |
An unique string decided by the merchant to prevent request duplication. |
Response Body Details
Parameter |
Type |
Description |
id |
String |
Wallet account id in UUID represented in String format. |
balanceInCents |
Int |
Wallet account balance amount as in cents. |
status |
String |
Wallet account status, Enum: "ACTIVE". |
groupId |
String |
Group id/name that wallet holder belongs to. |
country |
String |
Wallet account country in country code. |
currency |
String |
Wallet account settlement currency in currency code |
Error Response if Failed
Parameter |
Type |
Description |
code |
String |
Error code to indicate specific error types. |
errorMessage |
String |
Error message to indicate failure details. |