Payment - Ayolinx-Openapi

Request

Header Params

Content-Type

string

required

Example:

application/json

X-TIMESTAMP

string

required

客户端当地时间，格式为yyyy-MM-ddTHH:mm:ssXXX

Example:

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

X-SIGNATURE

string

required

使用对称签名算法 HMAC_SHA512(clientSecret, stringToSign) 并且转换成 base64.stringToSign = "{EndpointUrl}:{hashedRequestBody}:{bodyData)).EndpointUrl 格式: /direct-debit/core/v1/debit/payment-host-to-host

Example:

85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5

X-PARTNER-ID

string

required

商户ID，注册商户生成的唯一ID字符串

Example:

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

X-EXTERNAL-ID

string

required

字符串，每次请求生成唯一的request-id字符串

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

CHANNEL-ID

string

required

VA的Channel ID，直接填H2H

Example:

H2H

Body Params application/json

partnerServiceId

string

required

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

customerNo

string

required

是Ayolinx分配的，kyc后会提供

virtualAccountNo

string

required

partnerServiceId（8 位，左侧填充 0）+ customerNo（最多 20 位数字）。partnerServiceId + customerNo 或 virtualAccountNo

virtualAccountName

string

optional

客户名称

virtualAccountEmail

string

optional

客户邮箱

virtualAccountPhone

string

optional

客户手机号

trxId

string

required

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

paymentRequestId

string

required

请求ID

channelCode

string

optional

渠道code

hashedSourceAccountNo

string

optional

源账户号码（以哈希形式）

sourceBankCode

string

optional

源账户号码

trxDateTime

string

optional

交易时间

referenceNo

string

optional

referenceNo

paidBills

string

optional

paidBills

flagAdvise

string

optional

flagAdvise

paidAmount

object

required

支付金额

value

string

required

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

currency

string

required

货币类型

additionalInfo

object

required

channel

string

required

渠道号，例：VIRTUAL_ACCOUNT_BNI

paymentNtb

string

required

ayolinx系统内的本次交易唯一标识，可用于对账

paymentNtbVendor

string

required

银行的本次交易唯一标识

paymentTimeIso8601

string

required

银行那边的交易成功时间

Example

{
    "partnerServiceId": " 088899",
    "customerNo": "12345678901234567890",
    "virtualAccountNo": " 08889912345678901234567890",
    "virtualAccountName": "Jokul Doe",
    "virtualAccountEmail": "jokul@email.com",
    "virtualAccountPhone": "6281828384858",
    "trxId": "abcdefgh1234",
    "paymentRequestId": "abcdef-123456-abcdef",
    "channelCode": "6011",
    "hashedSourceAccountNo": "abcdefghijklmnopqrstuvwxyz123456",
    "sourceBankCode": "008",
    "paidAmount": {
        "value": "12345678.00",
        "currency": "IDR"
    },
    "cumulativePaymentAmount": {
        "value": "12345678.00",
        "currency": "IDR"
    },
    "paidBills": "95000",
    "totalAmount": {
        "value": "12345678.00",
        "currency": "IDR"
    },
    "trxDateTime": "20201231T235959Z",
    "referenceNo": "123456789012345",
    "journalNum": "123456",
    "paymentType": 1,
    "flagAdvise": "Y",
    "subCompany": "12345",
    "billDetails": [
        {
            "billCode": "01",
            "billNo": "123456789012345678",
            "billName": "Bill A for Jan",
            "billShortName": "Bill A",
            "billDescription": {
                "english": "Maintenance",
                "indonesia": "Pemeliharaan"
            },
            "billSubCompany": "00001",
            "billAmount": {
                "value": "12345678.00",
                "currency": "IDR"
            },
            "additionalInfo": {},
            "billReferenceNo": "123456789012345"
        }
    ],
    "freeTexts": [
        {
            "english": "Free text",
            "indonesia": "Tulisan bebas"
        }
    ],
    "additionalInfo": {}
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sandbox.ayolinx.id/v1.0/transfer-va/payment' \
--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 'CHANNEL-ID: H2H' \
--header 'Content-Type: application/json' \
--data-raw '{
    "partnerServiceId": " 088899",
    "customerNo": "12345678901234567890",
    "virtualAccountNo": " 08889912345678901234567890",
    "virtualAccountName": "Jokul Doe",
    "virtualAccountEmail": "jokul@email.com",
    "virtualAccountPhone": "6281828384858",
    "trxId": "abcdefgh1234",
    "paymentRequestId": "abcdef-123456-abcdef",
    "channelCode": "6011",
    "hashedSourceAccountNo": "abcdefghijklmnopqrstuvwxyz123456",
    "sourceBankCode": "008",
    "paidAmount": {
        "value": "12345678.00",
        "currency": "IDR"
    },
    "cumulativePaymentAmount": {
        "value": "12345678.00",
        "currency": "IDR"
    },
    "paidBills": "95000",
    "totalAmount": {
        "value": "12345678.00",
        "currency": "IDR"
    },
    "trxDateTime": "20201231T235959Z",
    "referenceNo": "123456789012345",
    "journalNum": "123456",
    "paymentType": 1,
    "flagAdvise": "Y",
    "subCompany": "12345",
    "billDetails": [
        {
            "billCode": "01",
            "billNo": "123456789012345678",
            "billName": "Bill A for Jan",
            "billShortName": "Bill A",
            "billDescription": {
                "english": "Maintenance",
                "indonesia": "Pemeliharaan"
            },
            "billSubCompany": "00001",
            "billAmount": {
                "value": "12345678.00",
                "currency": "IDR"
            },
            "additionalInfo": {},
            "billReferenceNo": "123456789012345"
        }
    ],
    "freeTexts": [
        {
            "english": "Free text",
            "indonesia": "Tulisan bebas"
        }
    ],
    "additionalInfo": {}
}'

Responses

🟢200OK

application/json

Body

responseCode

string

required

responseMessage

string

required

virtualAccountData

object

required

partnerServiceId

string

required

customerNo

string

required

virtualAccountNo

string

required

virtualAccountName

string

required

virtualAccountTrxType

string

optional

trxId

string

optional

totalAmount

object

optional

paymentRequestId

string

required

paidAmount

string

optional

paidBills

string

optional

trxDateTime

string

optional

referenceNo

string

optional

journalNum

string

optional

paymentType

string

optional

flagAdvise

string

optional

billDetails

array [object {9}]

optional

freeTexts

array [object {2}]

optional

additionalInfo

object

optional

paymentFlagReason

object

optional

Examples

SuccessException

{
    "responseCode": "2002500",
    "responseMessage": "Success",
    "virtualAccountData": {
        "partnerServiceId": "98829171",
        "customerNo": "30000000000000000001",
        "virtualAccountNo": "99991727425738",
        "virtualAccountName": "Customer Name",
        "virtualAccountTrxType": "C",
        "trxId": "232198297321111",
        "totalAmount": {
            "value": "12345678.00",
            "currency": "IDR"
        },
        "paymentRequestId": "abcdef-123456-abcdef",
        "paidAmount": {
            "value": "12345678.00",
            "currency": "IDR"
        },
        "billDetails": [
            {
                "billCode": "01",
                "billNo": "123456789012345678",
                "billName": "Bill A for Jan",
                "billShortName": "Bill A",
                "billDescription": {
                    "english": "Maintenance",
                    "indonesia": "Pemeliharaan"
                },
                "billSubCompany": "00001",
                "billAmount": {
                    "value": "12345678.00",
                    "currency": "IDR"
                },
                "additionalInfo": [],
                "billReferenceNo": "123456789012345"
            }
        ],
        "additionalInfo": {
            "channel": "VIRTUAL_ACCOUNT_BNI"
        },
        "paymentFlagReason": {
            "english": "Success",
            "indonesia": "Sukses"
        }
    }
}