Create VA - Ayolinx-Openapi

Request

Header Params

Content-Type

string

required

Example:

application/json

X-TIMESTAMP

string

required

参考 Header参数说明

Example:

2024-09-12T12:55:00+07:00

X-SIGNATURE

string

required

参考 Header参数说明

Example:

85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5

X-PARTNER-ID

string

required

参考 Header参数说明

Example:

CK-11111abc-0000-2222-bbcc-dd55555ee666

X-EXTERNAL-ID

string

required

参考 Header参数说明

Example:

418075533589

Authorization

string

required

Bearer "access token" ，从 Get B2B Token API获取

Example:

Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTgwNTA3NDMsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjExLTE2OTY5MTk2NTE5MTgifQ.x-D5VlK6TlVZbLPUSCr-Gbfgh4tnp0QDJmedYFHJGHFjg1c4x39pszU4sLvRhr0Jk0vKdMIzxUZeNhKoesWqDJitnG3kfrNZNsMb_WYUC0tJW91onXzYOKXiTgsHwRNFoWPQHlXIEtT3RQm-SRlCpk_E0gsavgkQn2-kbJEBnPhIs4eKg5IUY9GYi4hRr-_GHsudDl8sd2B5UBB_ 3EPXdbqb45N4ciQ

Body Params application/json

partnerServiceId

string

required

不同渠道不一样 BNI，对应值见【PartnerServiceId说明】

>= 1 characters<= 8 characters

customerNo

string

required

是Ayolinx分配的，kyc后会提供

>= 1 characters<= 20 characters

virtualAccountNo

string

optional

partnerServiceId（8 位）+ 随机生成8位数字。若不填则由ayolinx自动生成（目前暂不支持自定义virtualAccountNo，请传空）。

>= 1 characters<= 28 characters

virtualAccountName

string

required

客户名称

>= 1 characters<= 255 characters

trxId

string

required

唯一交易号，最小长度1，最大长度：64

>= 1 characters<= 64 characters

virtualAccountTrxType

string

optional

此交易的交易类型。C（固定金额），O（开放金额）。默认值为 C

>= 1 characters<= 1 characters

expiredDate

string

optional

客户自定义的过期时间，采用 “yyyy-MM-ddTHH:mm:ssXXX” 格式。例如：2024-09-20T06:36:36+00:00，时区请用雅加达时区

totalAmount

object

required

交易金额

value

string

required

交易净额。
如果是印尼盾（IDR），则值包含两位小数。
例如，IDR 10.000,- 将表示为 10000.00。
如果是open va，请传0.00

>= 1 characters<= 14 characters

currency

string

required

货币类型

>= 1 characters<= 3 characters

additionalInfo

object

required

其他参数

channel

string

required

渠道:
VIRTUAL_ACCOUNT_BNI
VIRTUAL_ACCOUNT_CIMB
VIRTUAL_ACCOUNT_MANDIRI
VIRTUAL_ACCOUNT_BRI

>= 1 characters<= 30 characters

urlParams

array [object {2}]

optional

回调地址，可以上传，也可以后台配置

type

string

required

NOTIFICATION

url

string

required

回调地址

Example

{
    "partnerServiceId": "98829172",
    "customerNo": "30000000000000000001",
    "virtualAccountNo": "4339382374532139",
    "virtualAccountName": "Customer Name",
    "trxId": "123321123321",
    "virtualAccountTrxType": "C",
    "totalAmount": {
        "value": "11500.00",
        "currency": "IDR"
    },
    "additionalInfo": {
        "channel": "VIRTUAL_ACCOUNT_BCA"
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://sandbox.ayolinx.id/v1.0/transfer-va/create-va' \
--header 'X-TIMESTAMP: 2024-09-12T12:55:00+07:00' \
--header 'X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5' \
--header 'X-PARTNER-ID: CK-11111abc-0000-2222-bbcc-dd55555ee666' \
--header 'X-EXTERNAL-ID: 418075533589' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTgwNTA3NDMsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjExLTE2OTY5MTk2NTE5MTgifQ.x-D5VlK6TlVZbLPUSCr-Gbfgh4tnp0QDJmedYFHJGHFjg1c4x39pszU4sLvRhr0Jk0vKdMIzxUZeNhKoesWqDJitnG3kfrNZNsMb_WYUC0tJW91onXzYOKXiTgsHwRNFoWPQHlXIEtT3RQm-SRlCpk_E0gsavgkQn2-kbJEBnPhIs4eKg5IUY9GYi4hRr-_GHsudDl8sd2B5UBB_ 3EPXdbqb45N4ciQ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "partnerServiceId": "98829172",
    "customerNo": "30000000000000000001",
    "virtualAccountNo": "4339382374532139",
    "virtualAccountName": "Customer Name",
    "trxId": "123321123321",
    "virtualAccountTrxType": "C",
    "totalAmount": {
        "value": "11500.00",
        "currency": "IDR"
    },
    "additionalInfo": {
        "channel": "VIRTUAL_ACCOUNT_BCA"
    }
}'

Responses

🟢200OK

application/json

Body

responseCode

string

required

>= 1 characters<= 7 characters

responseMessage

string

required

>= 1 characters<= 150 characters

virtualAccountData

object

required

partnerServiceId

string

required

>= 1 characters<= 8 characters

customerNo

string

required

>= 1 characters<= 20 characters

virtualAccountNo

string

required

>= 1 characters<= 28 characters

virtualAccountName

string

required

>= 1 characters<= 255 characters

virtualAccountEmail

string

optional

>= 1 characters<= 255 characters

virtualAccountPhone

string

optional

>= 9 characters<= 20 characters

virtualAccountTrxType

string

optional

>= 1 characters<= 1 characters

trxId

string

required

>= 1 characters<= 64 characters

totalAmount

object

optional

billDetails

string

optional

freeTexts

string

optional

feeAmount

string

optional

additionalInfo

object

optional

expiredDate

string

optional

Examples

SuccessException

{
    "responseCode": "2002700",
    "responseMessage": "",
    "virtualAccountData": {
        "partnerServiceId": "98829172",
        "customerNo": "30000000000000000001",
        "virtualAccountNo": "8473617259410240",
        "virtualAccountName": "Customer Name",
        "virtualAccountEmail": "",
        "virtualAccountPhone": "",
        "virtualAccountTrxType": "C",
        "trxId": "23219829714",
        "totalAmount": {
            "value": "11500.00",
            "currency": "IDR"
        },
        "billDetails": "",
        "freeTexts": "",
        "feeAmount": "",
        "additionalInfo": {
            "channel": "VIRTUAL_ACCOUNT_BCA"
        },
        "expiredDate": 1726371458
    }
}