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
      • Non-Snap APIS Need Merchant to Provide
        • Payment Notify
      • Snap APIS Need Merchant to provide
        • Access Token B2B
        • Payment Notify
    • EWallet
      • APIS Ayolinx Provided to Merchant
        • Get Payment Url
        • Inquiry Status
      • 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
    • Convenient store
      • APIS Ayolinx Provided To Merchant
        • Create retail transaction
          POST
        • retail query
          POST
      • APIS Need Merchant to Provid Copy
        • Payment Notify
  1. APIS Ayolinx Provided To Merchant

Create retail transaction

Developing
POST
/v1.0/retail/create

Request

Body Params application/json
partnerReferenceNo
string 
required
transaction id generated by merchant
validUpTo
string 
required
expiry time, YYYY-MM-DDTHH:mm:ss+07:00
customerName
string 
required
customer name
customerEmail
string 
required
customer email
customerPhone
string 
optional
customer phone
amount
object 
required
amount
currency
string 
required
currency IDR
value
string 
required
amount value
urlParams
array [object {2}] 
optional
url
url
string 
required
type
string 
required
PAY_RETURN
NOTIFICATION
additionalInfo
object 
required
channel
string 
required
RETAIL_ALFAMART
RETAIL_PEGADAIAN
RETAIL_POS_INDONESIA
RETAIL_ALFAMIDI
RETAIL_DANDAN
Example
{
    "partnerReferenceNo": "string",
    "validUpTo": "string",
    "customerName": "string",
    "customerEmail": "string",
    "customerPhone": "string",
    "amount": {
        "currency": "string",
        "value": "string"
    },
    "urlParams": [
        {
            "url": "string",
            "type": "string"
        }
    ],
    "additionalInfo": {
        "channel": "string"
    }
}

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/v1.0/retail/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "partnerReferenceNo": "string",
    "validUpTo": "string",
    "customerName": "string",
    "customerEmail": "string",
    "customerPhone": "string",
    "amount": {
        "currency": "string",
        "value": "string"
    },
    "urlParams": [
        {
            "url": "string",
            "type": "string"
        }
    ],
    "additionalInfo": {
        "channel": "string"
    }
}'

Responses

🟢200Success
application/json
Body
responseCode
string 
required
responseMessage
string 
required
partnerReferenceNo
string 
required
transaction id
expiryDate
string 
required
expiry time
vaNumber
string 
required
va number
paymentUrl
string 
required
payment url
Example
{
    "responseCode": "00",
    "responseMessage": "Successful",
    "partnerReferenceNo": "ei29dh29ee233UE383hf29hr",
    "expiryDate": "2024-09-12T12:55:00+07:00",
    "vaNumber": "021113791978",
    "paymentUrl": "https://passport.duitku.com/topup/topupdirectv2.aspx?ref=FT25ONEXEAPGG3C043O"
}
Previous
Payment Notify
Next
retail query