Ayolinx-Openapi
🇬🇧English
  • 🇬🇧English
  • 🇨🇳中文
  1. APIS Ayolinx Provided to Merchant
Ayolinx-Openapi
🇬🇧English
  • 🇬🇧English
  • 🇨🇳中文
  • Openapi-EN-US
    • Read before development
      • Introduction
      • Header Parameter Description
      • Signature generation rules
      • Channel description
      • Error code description
      • Callback description
      • PartnerServiceId description
    • GetAccessToken
      • Access Token B2B
    • Qris
      • APIS Ayolinx Provided to Merchant
        • Generate Qris
        • Query Qris
        • Cancel Qris
      • APIS Need Merchant to Provide
        • Payment Notify
    • EWallet
      • APIS Ayolinx Provided to Merchant
        • Get Payment Url
          POST
        • Inquiry Status
          POST
      • APIS Need Merchant to Provid
        • Payment Notify
    • VirtualAccount
      • APIS Ayolinx Provided To Merchant
        • Error Codes
        • Create VA
        • Inquiry Va
      • APIS Need Merchant To Provide
        • Callback introduction
        • Access Token B2B
        • Payment
      • Non-snap callback interface
        • Payment Notify
  1. APIS Ayolinx Provided to Merchant

Get Payment Url

Developing
POST
/direct-debit/core/v1/debit/payment-host-to-host

Request

Header Params
Content-Type
string 
required
Example:
application/json
X-TIMESTAMP
string 
required
Client's current local time in yyyy-MM-ddTHH:mm:ssZ format
Example:
2024-09-12T12:55:00+07:00
X-SIGNATURE
string 
required
The symmetric signature algorithm HMAC_SHA512(clientSecret, stringToSign) is used and converted to base64. stringToSign = "{method}:{EndpointUrl}:{token}:{hashedRequestBody}:{requestTimestamp}". hashedRequestBody = hash('sha256', json_encode(bodyData)). The format of EndpointUrl: /direct-debit/core/v1/debit/payment-host-to-host
Example:
85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID
string 
required
Unique ID for a partner (Merchant Client ID).
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
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
partnerReferenceNo
string 
required
transaction unique code generated by merchant
validUpTo
string 
required
The time when the payment will be automatically expired, timestamp or in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
amount
object 
required
amount
currency
string 
required
Currency
value
string 
required
Net amount of the transaction.
urlParams
array [object {2}] 
required
url params
type
string 
required
URL type with values: PAY_RETURN for redirect, NOTIFICATION for callback
Both of these parameters need to be passed.
url
string 
required
url
additionalInfo
object 
required
additional info
channel
string 
required
channel parameter EMONEY_DANA_SNAP
orderTitle
string 
optional
order title
subMerchantId
string 
optional
Submerchant id applyed from merchant to bank, if this param setted, when open the payment link, will show the name of this submerchant
externalStoreId
string 
optional
Given by bank, along with subMerchantId, need both subMerchantId and externalStoreId to modify the merchant name
Example
{
  "partnerReferenceNo": "fd3f5af0-af57-4513-95a8-77df45721edw",
  "validUpTo": "1746249942",
  "amount": {
    "currency": "IDR",
    "value": "30.00"
  },
  "urlParams": [
    {
      "type": "PAY_RETURN",
      "url": "https://dev-payment.ayolinx.id/status?h=f13ce04d-34c5-4a03-ac46-d608cab468a2"
    },
    {
      "type": "NOTIFICATION",
      "url": "https://dev-payment.ayolinx.id/status?h=f13ce04d-34c5-4a03-ac46-d608cab468a2"
    }
  ],
  "additionalInfo": {
    "channel": "EMONEY_DANA_SNAP"
  }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://sandbox.dev.ayolinx.id:9080/direct-debit/core/v1/debit/payment-host-to-host' \
--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 'Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTgwNTA3NDMsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjExLTE2OTY5MTk2NTE5MTgifQ.x-D5VlK6TlVZbLPUSCr-Gbfgh4tnp0QDJmedYFHJGHFjg1c4x39pszU4sLvRhr0Jk0vKdMIzxUZeNhKoesWqDJitnG3kfrNZNsMb_WYUC0tJW91onXzYOKXiTgsHwRNFoWPQHlXIEtT3RQm-SRlCpk_E0gsavgkQn2-kbJEBnPhIs4eKg5IUY9GYi4hRr-_GHsudDl8sd2B5UBB_ 3EPXdbqb45N4ciQ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "partnerReferenceNo": "fd3f5af0-af57-4513-95a8-77df45721edw",
    "validUpTo": "1746249942",
    "amount": {
        "currency": "IDR",
        "value":"30.00"
    },
    "urlParams":[
        {
            "type":"PAY_RETURN",
            "url":"https://dev-payment.ayolinx.id/status?h=f13ce04d-34c5-4a03-ac46-d608cab468a2"
        },
        {
            "type":"NOTIFICATION",
            "url":"https://dev-payment.ayolinx.id/status?h=f13ce04d-34c5-4a03-ac46-d608cab468a2"
        }
    ],
    "additionalInfo":{
        "channel":"EMONEY_DANA_SNAP"
    }
   
}'

Responses

🟢200Success
application/json
Body
responseCode
string 
required
responseMessage
string 
required
webRedirectUrl
string 
required
partnerReferenceNo
string 
required
Example
{
  "responseCode": "2005400",
  "responseMessage": "Success",
  "webRedirectUrl": "https://m.sandbox.dana.id/m/portal/cashier/checkout?bizNo=20250110111212800110166288701912477&timestamp=1736479628052&originSourcePlatform=IPG&mid=216620020030015007074&sign=aRAz%2FmuDkP3bXBtjobQ7VRJIRjhjX352T4r4Ggq%2FBZVrhokXPw8f1urdleeNQe8if3TDD6yD%2FVTP%2FImqT%2BEVNQ3WatV1fdUYkZ6mTaI9%2B%2BKLEHzXZiziapD971C0Zopa1zogEFw2UfanfMeYSyngaDwozLTOf5zGVBNqtIozFZMU5twcnpLtbDTdYkGX%2FLgwzqh3dKGirPQD7MrEqJrpF%2Foi34uNStgpwQUx6%2BRVBB9fu5M%2Fp65D8QfCgyztzr7p5xgKouLsu5sz1QiqHRJoFpRCFenqnNUZgwV%2FSbOWsBiDJBBhoxjcMzUNCISJubrj4Gt6gURwODVnWzHO2SIa8g%3D%3D&forceToH5=false",
  "partnerReferenceNo": "fd3f5af0-af57-4513-95a8-77df45721edx"
}
Modified at 2025-04-01 12:53:36
Previous
Payment Notify
Next
Inquiry Status