Payment - Ayolinx-Openapi

Request

Header Params

Content-Type

string

required

Example:

application/json

X-TIMESTAMP

string

required

Client's current local time in yyyy-MM-ddTHH:mm:ssXXX format

Example:

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

X-SIGNATURE

string

required

Algorithm symmetric signature HMAC_SHA256(clientSecret, stringToSign).

Example:

85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5

X-PARTNER-ID

string

required

Unique ID for a partner (Merchant Client Key).

Example:

CKSandbox-100dc9aa-f8ee-4a00-a933-6f4e8963b666

X-EXTERNAL-ID

string

required

Numeric string. Reference number that should be unique in the same day (request-id).

Example:

418075533589

CHANNEL-ID

string

required

channel ID for VA. Please fill with H2H (Host-To-Host).

Example:

H2H

Authorization

string

required

Bearer "access token" obtainedn from Get B2B Token API.

Example:

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

Body Params application/json

partnerServiceId

string

required

similar to company code/BIN,8 digit left padding space.

customerNo

string

required

Unique number (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo

virtualAccountNo

string

optional

partnerServiceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo.

virtualAccountName

string

optional

Customer Name.

virtualAccountEmail

string

optional

Customer Email.

virtualAccountPhone

string

optional

Customer Phone.

trxId

string

required

Invoice number in Partner system.For BNI min length: 1 | max length: 30

paymentRequestId

string

required

channelCode

string

optional

channel code

hashedSourceAccountNo

string

optional

Source account number in hash

sourceBankCode

string

optional

Source account

trxDateTime

string

optional

transaction date time

referenceNo

string

optional

paidBills

string

optional

flagAdvise

string

optional

paidAmount

object

required

paid amount

value

string

required

amount value

currency

string

required

Currency

additionalInfo

object

optional

channel

string

required

VIRTUAL_ACCOUNT_BNI

paymentNtb

string

required

aylinx flow id

paymentNtbVendor

string

required

bank flow id

paymentTimeIso8601

string

required

transaction success time

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: CKSandbox-100dc9aa-f8ee-4a00-a933-6f4e8963b666' \
--header 'X-EXTERNAL-ID: 418075533589' \
--header 'CHANNEL-ID: H2H' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTgwNTA3NDMsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjExLTE2OTY5MTk2NTE5MTgifQ.x-D5VlK6TlVZbLPUSCr-Gbfgh4tnp0QDJmedYFHJGHFjg1c4x39pszU4sLvRhr0Jk0vKdMIzxUZeNhKoesWqDJitnG3kfrNZNsMb_WYUC0tJW91onXzYOKXiTgsHwRNFoWPQHlXIEtT3RQm-SRlCpk_E0gsavgkQn2-kbJEBnPhIs4eKg5IUY9GYi4hRr-_GHsudDl8sd2B5UBB_ 3EPXdbqb45N4ciQ' \
--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

integer

required

responseMessage

string

required

virtualAccountData

object

required

partnerServiceId

string

required

customerNo

string

required

virtualAccountNo

string

required

virtualAccountName

string

required

virtualAccountEmail

string

optional

virtualAccountPhone

string

optional

virtualAccountTrxType

string

optional

trxId

string

required

totalAmount

object

optional

paymentRequestId

string

required

paidAmount

string

optional

paidBills

string

optional

trxDateTime

integer

optional

referenceNo

string

optional

journalNum

string

optional

paymentType

integer

optional

flagAdvise

integer

optional

paymentFlagStatus

integer

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"
        }
    }
}