Singapay Home Page
Logo Icon
  1. Accounts
  2. Create

Information

MethodPathFormatAuthentication
POST/api/v1.0/accountsjsonOAuth 2.0 with Access Token

Request Details

Headers Structure

FieldValueTypeMandatoryLengthDescriptionExample
X-PARTNER-IDapi_keyAlphanumericMandatoryAPI key obtained from the merchant dashboard.b3ed7d4b-a96c-6c08-b3c7-12c3124242d9
Acceptapplication/jsonAlphabeticMandatorySpecifies JSON as the expected response format.application/json
AuthorizationBearer {bearerToken}AlphanumericMandatoryBearer token obtained from the get access token endpoint.Bearer eyJ0eXAiOiJKV1{…}

Body Structure

FieldTypeMandatoryLengthDescriptionExample
nameAlphanumericMandatoryFull name of the account holderDhany Ahmad 19hapus
emailAlphanumericOptionalEmail address of the accountDhanyAhmad19@gmail.com
phoneAlphanumericOptionalPhone number associated with the account082371268163823

Body Example

{
    "name" : "Dhany Ahmad 19hapus",//'required|max:100',
    "phone" : "082371268163823",//'required|digits_between:9,15',
    "email" : "DhanyAhmad19@gmail.com"//'required|email|max:100',
}

Response Details

Response Structure

FieldTypeMandatoryLengthDescriptionExample
statusNumericMandatory3HTTP Status Code200
successBooleanMandatory1Indicates success statustrue
dataObjectConditionalSub account object
> idAlphanumericMandatorySub account ID01K96K1YWFEC0BAQ9E0ZY7W882
> nameAlphanumericMandatoryFull name of the account holderDhany Ahmad 19hapus
> emailAlphanumericMandatoryEmail address of the accountDhanyAhmad19@gmail.com
> phoneAlphanumericMandatoryPhone number associated082371268163823
> statusEnumMandatoryAccount status values: activeactive

Response Example

Success: Here’s an example of a successful response.

{
    "status": 200,
    "success": true,
    "data": {
        "id": "01K96K1YWFEC0BAQ9E0ZY7W882",
        "name": "Dhany Ahmad 19hapus",
        "email": "DhanyAhmad19@gmail.com",
        "phone": "082371268163823",
        "status": "active"
    }
}