Skip to main content

Direct Debit Payment

POST/rest/redirection/v1.0/debit/payment-host-to-host

This API is used to initiate payment from merchant's platform to DANA. For the easiest integration, use DANA's Libraries to implement DANA Widget Binding or DANA Widget Non Binding.

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

Idempotent Key & Usage Rules​

  • If there is no OTT, meaning when accessing the checkout URL user has to do login otherwise user can directly go to the cashier page.
  • 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
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: Transaction 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
urlParams
array of json object
Notify URL that merchant 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
isDeeplink
string
1 charactersRequired
Deeplink URL or not
externalStoreId
string
1 - 64 characters
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
validUpTo
string
25 characters
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.

pointOfInitiation
string
1 - 20 characters
Used for getting more info regarding source of request of the user
disabledPayMethods
string
1 - 64 characters
Payment method(s) that cannot be used for this
payOptionDetails
array of json object
Payment option that will be used for this payment
payMethod
string
1 - 64 charactersRequired
Payment Method. e.g. CREDIT_CARD. Refer to PayMethodEnum
BALANCE
string
Payment method with balance
COUPON
string
Payment method with coupon
NET_BANKING
string
Payment method with internet banking
CREDIT_CARD
string
Payment method with credit card
DEBIT_CARD
string
Payment method with debit card
VIRTUAL_ACCOUNT
string
Payment method with virtual account
OTC
string
Payment method with OTC
DIRECT_DEBIT_CREDIT_CARD
string
Payment method with direct debit of credit card
DIRECT_DEBIT_DEBIT_CARD
string
Payment method with direct debit of debit card
ONLINE_CREDIT
string
Payment method with online credit
LOAN_CREDIT
string
Payment method with DANA Cicil
NETWORK_PAY
string
Payment method with e-wallet
payOption
string
1 - 64 charactersRequired
Payment option which shows the provider of this payment e.g. CREDIT_CARD_VISA
transAmount
money
Trans amount. Contains two sub-fields:
1. Value: Transaction 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: Transaction 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 characters
Card token used for this payment
merchantToken
string
1 - 64 characters
Merchant token used for this payment
additionalInfo
json object
Additional information
topupAndPay
boolean
Top up and pay
payerAccountNo
string
1 - 64 characters
Number account of payer
saveCardAfterPay
boolean
Information save card after payment process
channelInfo
string
1 - 4096 characters
Information of channel
issuingCountry
string
1 - 8 characters
Information of issuing country
assetType
string
1 - 64 characters
Type of asset
extendInfo
string
1 - 4096 characters
Extend information
additionalInfo
json object
Additional information
additionalInfo.supportDeepLinkCheckoutUrl
string
1 - 64 charactersRequired
Additional information of deeplink checkout URL, value always true
additionalInfo.phoneNumber
string
1 - 64 characters
Additional information of user's phone number
additionalInfo.publicUserId
string
1 - 64 characters
Additional information of public user's identifier
additionalInfo.productCode
string
1 - 32 charactersRequired
Additional information of product code, value always 51051000100000000001
additionalInfo.order.buyer
json object
Additional information of buyer
userId
string
1 - 32 characters
DANA's user identifier
externalUserId
string
1 - 32 charactersConditional
External user identifier
Conditional Info
Y:= externalUserType is filled
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
additionalInfo.order.seller
json object
Additional information of seller
userId
string
1 - 32 characters
DANA's user identifier
externalUserId
string
1 - 32 charactersConditional
External user identifier
Conditional Info
Y:= externalUserType is filled
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
additionalInfo.order.orderTitle
string
1 - 64 charactersRequired
Additional information of order title
additionalInfo.order.merchantTransType
string
1 - 64 characters
Additional information of merchant transaction type
additionalInfo.order.orderMemo
string
1 - 64 characters
Additional information of order memo
additionalInfo.order.createdTime
string
25 characters
Additional information of created time, in format YYYY-MM-DDTHH:mm:ss+07:00.
Time must be in GMT+7 (Jakarta time)
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
price
money
Required
Goods price. Contains two sub-fields:
1. Value: Transaction 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
array of json object
Additional information of shipping
chargeAmount
money
Charge amount. Contains two sub-fields:
1. Value: Transaction 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.envInfo
json object
Required
Additional information of environment
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
string
The source platform is independent payment gateway
orderTerminalType
string
1 - 32 charactersRequired
Order terminal type, refer to OrderTerminalTypeEnum
APP
string
Mobile Application
WEB
string
Browser Web
WAP
string
Mobile Wap
SYSTEM
string
System Call
terminalType
string
1 - 32 charactersRequired
Terminal type, refer to TerminalTypeEnum
APP
string
Mobile Application
WEB
string
Browser Web
WAP
string
Mobile Wap
SYSTEM
string
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
additionalInfo.extendInfo
string
1 - 4096 characters
Additional information of extend
POST .../rest/redirection/v1.0/debit/payment-host-to-host HTTP/1.2
Content-type: application/json
X-TIMESTAMP: 2020-12-23T08:31:11+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
ORIGIN: www.hostname.com
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
CHANNEL-ID: 95221
{
  "partnerReferenceNo": "2020102900000000000001",
  "merchantId": "23489182303312",
  "subMerchantId": "310928924949487",
  "amount": {
          "value": "12345678.00",
          "currency": "IDR"
  },
  "urlParams": [{
      "url": "https://test.bi.go.id/v1/test",
      "type": "PAY_RETURN",
      "isDeeplink": "Y"
  }],
  "externalStoreId": "239840198240795109",
  "validUpTo": 2026-03-31T15:17:45+07:00,
  "pointOfInitiation": "Mobile App",
  "disabledPayMethods": "CREDIT_CARD",
  "payOptionDetails": [{
      "payMethod": "CREDIT_CARD",
      "payOption": "CREDIT_CARD_VISA",
      "transAmount": {
          "value": "12345678.00",
          "currency": "IDR"
      },
      "feeAmount": {
          "value": "12345678.00",
          "currency": "IDR"
      },
      "cardToken": "d89ca90ua90sd80as9809",
      "merchantToken": "a90ua90sd80d89cas9809",
      "additionalInfo": {
          "topupAndPay": "true",
          "payerAccountNo": "20050000000001503276",
          "saveCardAfterPay": "true",
          "channelInfo": "{\"key\" : \"value\" }",
          "issuingCountry": "IN",
          "assetType": "true",
          "extendInfo": "{ \"key\" : \"value\" }"
      }
  }],
  "additionalInfo": {
      "supportDeepLinkCheckoutUrl": true,
      "phoneNumber": "",
      "publicUserId": "",
      "productCode": "51051000100000000001",
      "order": {
          "buyer": {
              "externalUserType": "",
              "nickname": "",
              "externalUserId": "",
              "userId": ""
          },
          "seller": {
              "externalUserType": "",
              "nickname": "mike",
              "externalUserId": "",
              "userId": "216610000000010034501"
          },
          "orderTitle": "Women Summer Dress New White Lace  Sleeveless Cute Casual Summer Dresses  Vestidos roupas femininas WQW1045",
          "merchantTransType": "type",
          "orderMemo": "Memo",
          "createdTime": "2020-12-23T08:31:11+07:00",
          "goods": [{
              "unit": "Kg",
              "category": "travelling/subway",
              "price": {
                  "value": "10.00",
                  "currency": "IDR"
              },
              "merchantShippingId": "564314314574327545",
              "merchantGoodsId": "24525635625623",
              "description": "Women Summer Dress New White Lace Sleeveless Cute Casual Summer Dresses Vestidos roupas femininas WQW1045",
              "snapshotUrl": "[http://snap.url.com]",
              "quantity": "",
              "extendInfo": ""
          }],
          "shippingInfo": [{
              "chargeAmount": {
                  "value": "20.00",
                  "currency": "IDR"
              },
              "lastName": "Li",
              "trackingNo": "646431431322332133",
              "countryName": "JP",
              "merchantShippingId": "564314314574327545",
              "cityName": "Atlanta",
              "address1": "137 W San Bernardino",
              "address2": "4114 Sepulveda",
              "phoneNo": "2423-2322342",
              "areaName": "Rd",
              "email": "abc@gmail.com",
              "zipCode": "310001",
              "stateName": "GA",
              "faxNo": "2123-11113",
              "carrier": "Federal Express",
              "firstName": "Jim",
              "mobileNo": "13765443223"
          }],
          "extendInfo": ""
      },
      "mcc": "5732",
      "envInfo": {
          "sessionId": "8EU6mLl5mUpUBgyRFT4v7DjfQ3fcauthcenter",
          "tokenId": "a8d359d6-ca3d-4048-9295-bbea5f6715a6",
          "websiteLanguage": "en_US",
          "clientIp": "10.15.8.189",
          "osType": "Windows.PC",
          "appVersion": "1.0",
          "sdkVersion": "1.0",
          "sourcePlatform": "IPG",
          "orderOsType": "IOS",
          "merchantAppVersion": "1.0",
          "terminalType": "SYSTEM",
          "orderTerminalType": "WEB",
          "extendInfo": "{\"deviceId\":\"CV19A56370e8a00d54293aab8001e4794\"}"
          },
      "extendInfo": ""
  }
}
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
DANA checkout URL
Conditional Info
Y:= Successfully processed
additionalInfo
json object
Additional information
Content-Type: application/json
X-TIMESTAMP: 2020-12-23T08:31:11+07:00
{
    "responseCode": "2005400",
    "responseMessage": "Successful",
    "referenceNo": "2020102977770000000009",
    "partnerReferenceNo": "2020102900000000000001",
    "webRedirectUrl": "https://pjsp.com/universal?bizNo=REF993883&...",
    "additionalInfo":{}
}
ResponseCauseSolution
2005400Successful
Success to be processed
Mark Direct Debit Payment process as Success
4005400Bad Request
General request failed error
Mark Direct Debit Payment process as Failed. Retry request with proper parameter
4005401Invalid Field Format
Invalid format for certain field
Mark Direct Debit Payment process as Failed. Retry request with proper parameter
4005402Invalid Mandatory Field
Missing or invalid format on mandatory field
Mark Direct Debit Payment process as Failed. Retry request with proper parameter
4015400Unauthorized. [reason]
General unauthorized error
Mark Direct Debit Payment process as Failed. Retry request with proper parameter
4035402Exceeds Transaction Amount Limit
Exceeds transaction amount limit
Mark Direct Debit Payment process as Failed. Try to adjust the order amount
4035405Do Not Honor
Account or user status is abnormal
Mark Direct Debit Payment process as Failed. Retry request with proper parameter or can contact DANA to check the user/account status
4035415Transaction Not Permitted.[reason]
Transaction not permitted
Mark Direct Debit Payment process as Failed. Retry request periodically or consult to DANA
4045408Invalid Merchant
Merchant does not exist or status abnormal
Mark Direct Debit Payment process as Failed. Retry request with proper parameter
4045418Inconsistent Request
Inconsistent request parameter found for the same partner reference number/transaction identifier
Mark Direct Debit Payment process as Failed. Retry with proper parameter
4295400Too Many Requests
Maximum transaction limit exceeded
Mark Direct Debit Payment process as Pending. Retry request periodically by sending same request payload
5005400General Error
General error non retry-able
Mark Direct Debit Payment process as Failed. Retry request periodically
5005401Internal Server Error
Unknown internal server failure, please retry the process again
Mark Direct Debit Payment 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 Direct Debit Payment 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 Direct Debit Payment process as Pending
• If empty field/field does not exist, mark Direct Debit Payment 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.