Skip to content

create a sub accountV2

Create a sub-account

Create a sub-account to the merchant.

HTTP Request

POST /v1/mx/payments/charges/spei/create

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "idempotencyKey": "9009f382-addc-11eb-8529-0242ac130003",
    "friendlyName": "{{TARGET_ACCOUNT_FRIENDLY_NAME}}",
    "legalName": "{{TARGET_ACCOUNT_LEGAL_NAME}}",
    "phoneNumber": "{{TARGET_ACCOUNT_PHONE_NUMBER}}"
}
Content-Type: application/json
{
    "statusCode": 200,
    "errorMsg": "",
    "idempotencyKey": "9009f382-addc-11eb-8529-0242ac130003",
    "accountUuid":"{{CREATED_SUB_ACCOUNT_UUID}}",
    "accountId":"{{CREATED_SUB_ACCOUNT_CLABE_NUMBER}}",
    "friendlyName":"{{TARGET_ACCOUNT_FRIENDLY_NAME}}",
    "legalName":"{{TARGET_ACCOUNT_LEGAL_NAME}}",
    "phoneNumber":"{{TARGET_ACCOUNT_PHONE_NUMBER}}"
}

HTTP Headers Details

Key Value
Content-Type application/json
Authorization "bearer"+ "" + {{access_token}}
x-api-key {{api_key}}

PATH and Query Parameters

Parameter Required Type Description
idempotencyKey String Unique key to ensure idempotent requests
friendlyName String The friendly name of the subAccount (used on displays).
legalName String The formal, legal name of the subAccount.
phoneNumber String The phoneNumber associated with this subAccount.

Response Body Details

Parameter Type Description
statusCode Integer 200 Success, 401 Access denied, 422 Required fields missing or invalid data, 500 internal error.
errorMsg String Error message if failed.
idempotencyKey String Unique key provided by creating sub account request
accountUuid UUID The UUID of the subaccount that was created.
accountId String The created sub-account clabe number.
friendlyName String The friendly name of the merchant (used on displays).
legalName String The formal, legal name of the merchant.
phoneNumber String The phoneNumber associated with this subAccount.This parameter will not be returned if it is not filled
Back to top