Skip to main content

Create Order

POST/payment-gateway/v1.0/debit/payment-host-to-host.htm

This API allows merchants to create orders on the DANA for Payment Gateway functionality. For the easiest integration, use DANA's Libraries to implement Custom Checkout.

API Type
SNAP API
Expected Timeout
8 second
SNAP Service Code
54
Accept
application/json
Content Type
applciation/json

Idempotent Key & Usage Rules​

Idempotent is controlled by Idempotent Key ( merchantId + partnerReferenceNo)

  • If Idempotent Key has been created and the key information is consistent, then Response code 2005400 (success) will be returned.
  • If Idempotent Key has been created but the key information isn’t consistent, then Response code 4045418 (inconsistent request) will be returned.
Content-Type
string
1 - 127 charactersRequired
Content type, value always application/json
X-TIMESTAMP
string
25 charactersRequired
Transaction date time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
X-SIGNATURE
string
Required
Signature need to be generated with asymmetricSignature method
ORIGIN
string
Origin domain
X-PARTNER-ID
string
1 - 36 charactersRequired
Unique identifier for partner was generated by DANA, or known as clientId
X-EXTERNAL-ID
string
1 - 36 charactersRequired
Unique messaging reference identifier generated by merchant and should be unique within the same day
CHANNEL-ID
string
1 - 5 charactersRequired
Device identification on which the API services is currently being accessed by the end user (customer)
partnerReferenceNo
string
1 - 64 charactersRequired
Unique transaction identifier in partner system for each transaction.
Note:
  • When retrying after a timeout or unexpected response, use the same partnerReferenceNo as in the original request.
  • For QRIS, the maximum length for partnerReferenceNo is 25 characters.
merchantId
string
1 - 64 charactersRequired
Merchant identifier that is unique per each merchant
subMerchantId
string
1 - 32 characters
Sub merchant identifier, known as externalDivisionId must be registered in the DANA system before use. To register a new externalDivisionId, use the Create Division API
amount
money
Required
Amount. Contains two sub-fields:
1. Value: Amount, including the cents
2. Currency: Currency code based on ISO
value
string
1 - 19 charactersRequired
Value of amount. Following ISO-4217, for IDR the value includes 2 decimal digits separated with point e.g. ,IDR 10.000,- will be placed with 10000.00
currency
string
1 - 3 charactersRequired
Currency
externalStoreId
string
1 - 64 charactersConditional
Store identifier to indicate to which store this payment belongs to, known as externalShopId must be registered in the DANA system before use. To register a new externalShopId, use the Create Shop API
Conditional Info
Y:= Implement QRIS Payment Method
validUpTo
string
25 charactersRequired
The time when the payment will be automatically expired, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
Note

This must be set to a future time. In the Sandbox environment, the default expiration is 30 minutes.

urlParams
array of json object
Required
Notify URL that DANA must send the payment notification to
url
string
1 - 512 charactersRequired
URL link
type
string
1 - 32 charactersRequired
URL type with values:
• NOTIFICATION: When finish payment, DANA will notify to the URL that has been defined by partner
• PAY_RETURN: After the payment, the user will be redirected to merchant page, this is mandatory
isDeeplink
string
1 charactersRequired
Deeplink URL or not
payOptionDetails
array of json object
Required
Payment option that will be used for this payment
payMethod
string
1 - 64 charactersRequired
Payment method e.g., NETWORK_PAY, refer to PayMethodEnum
BALANCE
Payment method with DANA balance
COUPON
Payment method with coupon
NET_BANKING
Payment method with internet banking
CREDIT_CARD
Payment method with credit card
DEBIT_CARD
Payment method with debit card
VIRTUAL_ACCOUNT
Payment method with virtual account
OTC
Payment method with OTC
ONLINE_CREDIT
Payment method with online credit
LOAN_CREDIT
Payment method with DANA Cicil
NETWORK_PAY
Payment method with e-wallet
Note

In sandbox, only BALANCE, CREDIT_CARD, DEBIT_CARD, VIRTUAL_ACCOUNT, NETWORK_PAY are available.

payOption
string
1 - 64 charactersRequired
Payment option which shows the provider of this payment, refer to PayOptionEnum
Note

In sandbox, only CARD, QRIS, BRI, PANIN, CIMB, MANDIRI, and BTPN are available.

transAmount
money
Required
Trans amount. Contains two sub-fields:
1. Value: Amount, including the cents
2. Currency: Currency code based on ISO
value
string
1 - 19 charactersRequired
Value of amount. Following ISO-4217, for IDR the value includes 2 decimal digits separated with point e.g. ,IDR 10.000,- will be placed with 10000.00
currency
string
1 - 3 charactersRequired
Currency
feeAmount
money
Fee amount. Contains two sub-fields:
1. Value: Amount, including the cents
2. Currency: Currency code based on ISO
value
string
1 - 19 charactersRequired
Value of amount. Following ISO-4217, for IDR the value includes 2 decimal digits separated with point e.g. ,IDR 10.000,- will be placed with 10000.00
currency
string
1 - 3 charactersRequired
Currency
cardToken
string
1 - 64 charactersConditional
Token that used for payment with card
Conditional Info
Y:= Card Payment
merchantToken
string
1 - 64 characters
Merchant token used for this payment
additionalInfo
json object
Additional information
phoneNumber
string
1 - 15 charactersConditional
User’s phone number
Conditional Info
Y:= Card and e-wallet Payment
paymentCode
string
1 - 64 charactersConditional
Payment code that used for payment with virtual account
Conditional Info
Y:= Virtual account Payment
additionalInfo.promoInfos
array of json object
Conditional
Additional Information of promotion
Conditional Info
Y:= Want to apply the promo
promoAmount
money
Required
Fee amount. Contains two sub-fields:
1. Value: Amount, including the cents
2. Currency: Currency code based on ISO
value
string
1 - 19 charactersRequired
Value of amount. Following ISO-4217, for IDR the value includes 2 decimal digits separated with point e.g. ,IDR 10.000,- will be placed with 10000.00
currency
string
1 - 3 charactersRequired
Currency
promoId
string
1 - 64 charactersRequired
Promo identifier
promoType
string
1 - 32 charactersRequired
Type’s of promo, value always DIRECT_DISCOUNT
additionalInfo
json object
Additional information
additionalInfo.order.orderTitle
string
1 - 64 charactersRequired
Additional information of order title
additionalInfo.order.scenario
string
1 - 64 charactersRequired
Additional information of order scenario, value always API
REDIRECT
string
Merchant will be redirected to DANA checkout page
API
string
Merchant can implement own User interface
additionalInfo.order.merchantTransType
string
1 - 64 characters
Additional information of merchant transaction type
additionalInfo.order.buyer
json object
Required
Additional information of buyer
externalUserType
string
1 - 32 charactersConditional
Type of external user
Conditional Info
Y:= externalUserId is filled
nickname
string
1 - 64 characters
Nickname, user’s nick name in DANA’s
externalUserId
string
1 - 32 charactersConditional
External user identifier
Conditional Info
Y:= externalUserType is filled
userId
string
1 - 32 characters
DANA’s user identifier
additionalInfo.order.goods
array of json object
Additional information of goods
unit
string
1 - 64 characters
Goods unit
category
string
1 - 64 charactersRequired
Goods category
name
string
1 - 64 charactersRequired
Goods name
price
money
Required
Goods price. Contains two sub-fields:
1. Value: Amount, including the cents
2. Currency: Currency code based on ISO
value
string
1 - 19 charactersRequired
Value of amount. Following ISO-4217, for IDR the value includes 2 decimal digits separated with point e.g. ,IDR 10.000,- will be placed with 10000.00
currency
string
1 - 3 charactersRequired
Currency
merchantShippingId
string
1 - 64 characters
Shipment identifier provided by merchant
merchantGoodsId
string
1 - 64 charactersRequired
Goods identifier provided by merchant
description
string
1 - 1024 charactersRequired
Goods description
snapshotUrl
string
1 - 512 characters
The URL of good’s snapshot web page
quantity
string
1 - 16 charactersRequired
Count of items
extendInfo
string
1 - 4096 characters
Extend information
additionalInfo.order.shippingInfo
json object
Additional information of shipping info
chargeAmount
money
Charge amount. Contains two sub-fields:
1. Value: Amount, including the cents
2. Currency: Currency code based on ISO
value
string
1 - 19 charactersRequired
Value of amount. Following ISO-4217, for IDR the value includes 2 decimal digits separated with point e.g. ,IDR 10.000,- will be placed with 10000.00
currency
string
1 - 3 charactersRequired
Currency
lastName
string
1 - 64 charactersRequired
Last name
trackingNo
string
1 - 64 characters
Number of tracking
countryName
string
1 - 64 charactersRequired
Name of country
merchantShippingId
string
1 - 64 charactersRequired
Merchant shipping identifier
cityName
string
1 - 64 charactersRequired
Name of city
address1
string
1 - 256 charactersRequired
Information of address 1
address2
string
1 - 256 characters
Information of address 2
phoneNo
string
1 - 32 characters
Phone number
areaName
string
1 - 64 characters
Name of area
email
string
1 - 128 characters
Email
zipCode
string
1 - 32 charactersRequired
Zip code
stateName
string
1 - 64 charactersRequired
Name of state
faxNo
string
1 - 32 characters
Fax number
carrier
string
1 - 64 characters
Information of carrier
firstName
string
1 - 64 charactersRequired
First name
mobileNo
string
1 - 32 characters
Mobile number
additionalInfo.order.extendInfo
string
1 - 4096 characters
Additional information of extend
additionalInfo.mcc
string
1 - 64 charactersRequired
Additional information of merchant category code. This parameter is used to identify the type of business in which a merchant is engaged. Refer to Details of Merchant Category Code
additionalInfo.extendInfo
string
1 - 4096 characters
Additional information of extend such as partner passthrough and risk information
additionalInfo.envInfo
json object
Required
Additional information of environment info
sessionId
string
1 - 128 characters
Session identifier
tokenId
string
1 - 128 characters
Token identifier
websiteLanguage
string
1 - 16 characters
Website language
clientIp
string
1 - 32 characters
Client IP address
osType
string
1 - 128 characters
Operating system type
appVersion
string
1 - 128 characters
App version
sdkVersion
string
1 - 128 characters
SDK version
sourcePlatform
string
1 - 32 charactersRequired
Source platform, refer to SourcePlatformEnum
IPG
The source platform is independent payment gateway
clientKey
string
1 - 64 characters
Unique identifier for partner was generated by DANA
orderTerminalType
string
1 - 32 charactersRequired
Order terminal type, refer to OrderTerminalTypeEnum
APP
Mobile Application
WEB
Browser Web
WAP
Mobile Wap
SYSTEM
System Call
terminalType
string
1 - 32 charactersRequired
Terminal type, refer to TerminalTypeEnum
APP
Mobile Application
WEB
Browser Web
WAP
Mobile Wap
SYSTEM
System Call
orderOsType
string
1 - 128 characters
Order operating system type
merchantAppVersion
string
1 - 128 characters
Merchant App version
extendInfo
string
1 - 4096 characters
Extend information
subMerchantId & externalStoreId

Check yours here: https://dashboard.dana.id/sandbox/submerchants

If you're an aggregator: subMerchantId is mandatory subMerchantId is equal to externalDivisionId, obtained from the Create Division API or DANA Sandbox Dashboard.

If you use QRIS or have outlets/stores under you: externalStoreId is mandatory
externalStoreId can be obtained from the Create Shop API or DANA Sandbox Dashboard.

Request Sample Gapura Custom Checkout - BALANCE
POST .../payment-gateway/v1.0/debit/payment-host-to-host.htm
Content-Type: application/json
X-TIMESTAMP: 2024-12-23T09:10:11+07:00 
X-SIGNATURE: to fill ...
X-PARTNER-ID: 82150823919040624621823174737537 
X-EXTERNAL-ID: 41807553358950093184162180797837 
CHANNEL-ID: 95221 
{
  "partnerReferenceNo":"2020102900000000000001",
  "merchantId":"23489182303312",
  "amount":{
    "value":"15000.00",
    "currency":"IDR"
  },
  "validUpTo": 2026-04-06T11:47:08+07:00,
  "urlParams":[
    {
        "url":"https://test.bi.go.id/v1/test",
        "type":"PAY_RETURN",
        "isDeeplink":"Y"
    },
    {
        "url":"https://test.bi.go.id/v1/test",
        "type":"NOTIFICATION",
        "isDeeplink":"Y"
    }
  ],
  "payOptionDetails":
  [
    {
      "payMethod": "BALANCE",
      "payOption": "",
      "transAmount": {
        "value": "15000.00",
        "currency": "IDR"
      }
    }
  ],
  "additionalInfo":{
    "order":{
        "orderTitle":"Payment Gateway Order",
        "scenario":"API"
    },
    "mcc":"5814",
    "envInfo":{
        "sourcePlatform":"IPG",
        "terminalType":"SYSTEM"
    }
  }
}
Content-Type
string
1 - 127 charactersRequired
Content type, value always application/json
X-TIMESTAMP
string
25 charactersRequired
Transaction date time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
responseCode
string
7 charactersRequired
Refer to response code list
responseMessage
string
1 - 150 charactersRequired
Refer to response code list
referenceNo
string
1 - 64 charactersConditional
Transaction identifier on DANA system
Conditional Info
Y:= Successfully processed
partnerReferenceNo
string
1 - 64 charactersRequired
Unique transaction identifier in partner system for each transaction.
Note: When retrying after a timeout or unexpected response, use the same partnerReferenceNo as in the original request
webRedirectUrl
string
1 - 2048 charactersConditional
Checkout URLs
Conditional Info
Y:= Successfully processed if the payment method is not OVO/Virtual Account/QRIS
additionalInfo.paymentCode
string
1 - 64 charactersConditional
Additional information of payment code
Conditional Info
Y:= Payment using Virtual Account/QRIS
Note

When using static virtual accounts, DANA automatically defines the payment code for all banks except CIMB. If merchant are using CIMB, they can define your own custom payment code. Please note that this custom payment code for CIMB only applies to the Production environment, not Sandbox.

Content-Type: application/json
X-TIMESTAMP: 2024-12-23T09:10:11+07:00
{
  "responseCode": "2005400",
  "responseMessage": "Successful",
  "referenceNo": "2020102977770000000009",
  "partnerReferenceNo": "2020102900000000000001",
  "webRedirectUrl": "https://pjsp.com/universal?bizNo=REF993883&...",
  "additionalInfo": {
    "paymentCode": "086262535263233"
  }
}
ResponseCauseSolution
2005400Successful
Success to be processed
Mark Create Order process as Success
4005400Bad Request
General request failed error
Mark Create Order process as Failed. Retry request with proper parameter
4005401Invalid Field Format
Invalid format for certain field
Mark Create Order process as Failed. Retry request with proper parameter
4005402Invalid Mandatory Field
Missing or invalid format on mandatory field
Mark Payment Create Order as Failed. Retry request with proper parameter
4015400Unauthorized. Invalid Signature
Signature is invalid
Mark Create Order process as Failed. Retry request with proper parameter
4035402Exceeds Transaction Amount Limit
Exceeds transaction amount limit
Mark Create Order process as Failed. Try to adjust the order amount
4035405Do Not Honor
Account or user status is abnormal
Mark Create Order process as Failed. Retry request with proper parameter or can contact DANA to check the user/account status
4035415Transaction Not Permitted
Transaction not permitted
Mark Create Order process as Failed. Retry request periodically or consult to DANA
4045408Invalid Merchant
Merchant does not exist or status abnormal
Mark Create Order process as Failed. Retry request with proper parameter
4045418Inconsistent Request
Inconsistent request parameter found for the same partner reference number/transaction identifier
Mark Create Order process as Failed. Retry with proper parameter
4295400Too Many Requests
Maximum transaction limit exceeded
Mark Create Order process as Pending. Retry request periodically by sending same request payload
5005400General Error
General error
Mark Create Order process as Failed. Retry request periodically
5005401Internal Server Error
Unknown internal server failure, please retry the process again
Mark Create Order process as Pending. Retry request periodically by sending same request payload
Total timeout
Total timeout, the client side does not get any responses from the server side (Can be due to network issue, server slowing down, and so on)
Do a retry maximum 3 attempts by sending same request payload, if still fails mark Create Order process as Pending
Unexpected response (Empty field/field does not exist/undefined response code)
The server does not produce expected responses (Can be due to hardware failure, bugs, and so on)
  • If the response code prefix are 202 and 5XX, mark Create Order process as Pending

  • If empty field/field does not exist, mark Create Order process as Pending
ask AIAI Assistant
Need help with our documentation?
Start from our frequently asked questions or feel free to ask anything else.

AI generated responses may contain mistakes.