Skip to main content

Customer Top Up

POST/v1.0/emoney/topup.htm

This API is used for merchant to do top up request to DANA

API Type
SNAP API
Expected Timeout
8 second
SNAP Service Code
38
Accept
application/json
Content Type
application/json
Content-type
string
1 - 127 charactersRequired
Content type, value always application/json
Authorization
string
1 - 2048 charactersConditional
Contains bearer JWT token, which has been obtained from Authorization Token Request API
Conditional Info
Y:= Signature option is symmetric approach
Authorization-Customer
string
1 - 512 charactersConditional
  • Contains customer token, which has been obtained from binding process
  • If request is coming from user interaction, this field is mandatory. If not, just filled customerNumber
Conditional Info
Y:= customerNumber is not exist
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 symmetricSignature or 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
X-IP-ADDRESS
string
15 characters
IP address of the end user (customer) using IPv4 format
X-DEVICE-ID
string
1 - 400 charactersConditional
Device identification on which the API services is currently being accessed by the end user (customer)
Sample:
  • Web Application:
    • Mozilla / 5.0 (Windows NT 10.0; Win64; x64)
    • AppleWebKit / 537.36 (KHTML, like Gecko)
    • Chrome / 75.0.3770.100
    • Safari / 537.36 OPR / 62.0.3331.99
  • Mobile Application:
    • Android: android-20013adf6cdd8123f
    • iOS: 72635bdfd223yvjm7246nsdj34hd455 9393kjh42
Conditional Info
Y:= Authorization Customer is exist
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

customerNumber
string
1 - 32 charactersConditional
Beneficiary customer phone number in DANA, in format 628xxx
Conditional Info
Y:= Authorization Customer is not exist
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
feeAmount
money
Required
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
transactionDate
string
25 characters
Transaction date, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
sessionId
string
1 - 25 characters
Session identifier
categoryId
numeric
1 - 10 characters
Category identifier
notes
string
1 - 255 characters
Transaction notes
additionalInfo
json object
Additional information
fundType
string
1 - 64 charactersRequired
Additional information of top up fund type, value always AGENT_TOPUP_FOR_USER_SETTLE
externalDivisionId
string
1 - 64 characters
Additional information of external division identifier. (fundType: AGENT_TOPUP_FOR_USER_SETTLE)
Note

It is generally optional, but becomes mandatory if the additionalInfo.chargeTarget value is set to DIVISION.

chargeTarget
string
1 - 64 characters
Additional information of charge target. The values are:
  • null
  • DIVISION
  • MERCHANT
Note

If the value is DIVISION, externalDivisionId will be Mandatory

subScenario
string
1 - 64 charactersConditional
Additional information of sub scenario, value always GLOBAL_REMITTANCE
Conditional Info
Y:= Cross border remittance scenario
extendInfo
string
1 - 4096 characters
Additional information of extend
instructedAmountType
string
1 - 64 characters
Additional information of type of instructed amount
payerPaymentMethod
json object
Required
Additional information of method of payer payment
walletDetail
json object
Conditional
Information details of cash/wallet
Conditional Info
Y:= paymentMethodType=WALLET
walletName
string
1 - 128 charactersRequired
Wallet name
customerId
string
1 - 64 charactersRequired
Customer unique identifier assigned by participant
customerName
json object
Information details of customer name
firstName
string
1 - 32 characters
Customer’s first name
lastName
string
1 - 32 characters
Customer’s last name
fullName
string
1 - 128 charactersRequired
Customer’s full name
middleName
string
1 - 32 characters
Customer’s middle name
bankDetail
json object
Conditional
Information details of Bank/cash
Conditional Info
Y:= paymentMethodType=BANK
accountType
string
1 - 32 characters
Type of account
accountNo
string
1 - 64 charactersConditional
Account number
Conditional Info
Y:= paymentMethodType=BANK
accountName
string
1 - 128 characters
Account name
bankName
string
1 - 128 charactersConditional
Bank name
Conditional Info
Y:= paymentMethodType=BANK
officeOpeningAccount
string
1 - 128 characters
The Bank of account opening
swiftCode
string
1 - 16 charactersConditional
Bank identifier code for cross-border financial transactions
Conditional Info
Y:= paymentMethodType=BANK
currency
string
1 - 3 characters
Currency
iban
string
1 - 64 characters
An international Bank account code to identify offshore Bank accounts
sourceOfFund
string
1 - 32 characters
Fund source, which has values:
  • SALARY
  • BUSSINESS
  • UNKNOWN
paymentMethodType
string
1 - 32 charactersRequired
Payer’s type of payment method, which has values:
  • WALLET
  • BANK
  • CASH
bizSceneType
string
1 - 64 characters
Additional information of type of Bizscene
transferToAmount
money
Additional information of transfer to 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
transferFromAmount
money
Additional information of transfer from 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
additionalTransferDetails
json object
Additional information of transfer details
beneficiary
json object
Required
Beneficiary user information
nationality
string
2 characters
Code of nationality. Refer to ISO-3166 country/region code
userName
json object
Information details of user name
firstName
string
1 - 32 characters
User’s first name
lastName
string
1 - 32 characters
User’s last name
fullName
string
1 - 128 charactersRequired
User’s full name
middleName
string
1 - 32 characters
User’s middle name
transferPurpose
string
1 - 32 characters
Type of transfer purpose, such as:
  • FAMILY_SUPPORT
  • SALARY
  • EDUCATION
  • OTHER
transferFromRegion
string
2 charactersRequired
Payer’s country or region. Refer to ISO-3166 country/region code
payer
json object
Required
Information details of payer
userAddress
json object
Required
Information detail of user address
zipCode
string
1 - 32 characters
ZIP or postal code of user
city
string
1 - 32 charactersRequired
City, district, suburb, town, or village
address2
string
1 - 256 characters
Address line 2
address1
string
1 - 256 characters
Address line 1
region
string
2 charactersRequired
Code of region. Refer to ISO-3166 country/region code
province
string
1 - 32 characters
User’s address province
district
string
1 - 32 characters
User’s address district
nationality
string
2 characters
Code of nationality. Refer to ISO-3166 country/region code
userPhoneNo
string
1 - 32 charactersRequired
User’s contact number
certificate
json object
Information details of certificate
certificateNo
string
1 - 64 charactersRequired
Certificate number
certificateType
string
1 - 32 characters
Type of certificate, which has values:
  • ID_CARD
  • Passport
certificateIssuingCountry
string
1 - 2 characters
Country of certificate issuance. Refer to ISO-3166 country/region code
userName
json object
Information details of user name
firstName
string
1 - 32 characters
User’s first name
lastName
string
1 - 32 characters
User’s last name
fullName
string
1 - 128 charactersRequired
User’s full name
middleName
string
1 - 32 characters
User’s middle name
userId
string
1 - 64 characters
Unique user identifier
birthDate
string
1 - 8 characters
Date of birth. Formatted in YYYYMMDD
title
string
1 - 8 characters
User’s title, which has values:
  • MR
  • MRS
  • MS
gender
string
1 - 16 characters
User’s gender, which has values:
  • MALE
  • FEMALE
birthPlace
string
1 - 64 characters
User's birthplace
politicalExposedPerson
string
1 characters
A Politically Exposed Person (PEP) options, which has values:
  • Y
  • N
occupation
string
1 - 64 characters
User’s occupation
userPhoneAreaCode
string
1 - 8 characters
User’s phone area code
userPhoneExtension
string
1 - 8 characters
User’s phone extension
email
string
1 - 128 characters
User’s email
transferToRegion
string
2 charactersRequired
Beneficiary’s country or region. Refer to ISO-3166 country/region code
accessToken
string
1 - 512 charactersConditional
  • Contains customer token, which has been obtained from binding process
  • If request is coming from user interaction, this field is mandatory. If not, just filled customerNumber
Conditional Info
Y:= customerNumber is not exist
Wallet
POST /v1.0/emoney/topup.htm HTTP/1.2
Content-type: application/json
Authorization: Bearer gp9HjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a
Authorization-Customer: Bearer fa8sjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a
X-TIMESTAMP: 2020-12-21T17:07:11+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
ORIGIN: www.hostname.com
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
X-IP-ADDRESS: 172.24.281.24
X-DEVICE-ID: 09864ADCASA
CHANNEL-ID: 95221

{
    "partnerReferenceNo": "2020102900000000000001",
    "customerNumber": "6281773628883",
    "amount": {
        "value": "10000.00",
        "currency": "IDR"
    },
    "feeAmount": {
        "value": "10000.00",
        "currency": "IDR"
    },
    "transactionDate": "2020-12-21T14:56:11+07:00",
    "sessionId": "883737GHY8839",
    "categoryId": "6",
    "notes": "notes test",
    "additionalInfo": {
        "fundType": "AGENT_TOPUP_FOR_USER_SETTLE",
        "externalDivisionId": "91080916Division",
        "chargeTarget": "DIVISION",
        "subScenario": "GLOBAL_REMITTANCE",
        "extendInfo": {
          "instructedAmountType": "TRANSFER_TO",
          "payerPaymentMethod": {
            "walletDetail": {
              "walletName": "HK_WALLET",
              "customerId": "123456789",
              "customerName": {
                "firstName": "William",
                "lastName": "Clinton",
                "fullName": "William Jefferson Clinton",
                "middleName": "Jefferson"
              }
            },
            "paymentMethodType": "WALLET",
            "sourceOfFund": ""
           },
          "bizSceneType": "TRANSFER",
          "transferToAmount": {
            "currency": "IDR",
            "value": "5000000.00"
          },
          "transferFromAmount": {
            "currency": "USD",
            "value": "70000.00"
          },
          "additionalTransferDetails": {
            "beneficiary": {
              "nationality": "ID",
              "userName": {
                "firstName": "Patrick",
                "lastName": "Star",
                "fullName": "Patrick Star",
                "middleName": ""
              }
            },
            "transferPurpose": "FAMILY_SUPPORT",
            "transferFromRegion": "KR",
            "payer": {
              "userAddress": {
                "zipCode": "04072",
                "city": "SEOUL",
                "address2": "366-1. Hapjeong-dong",
                "address1": "Mapo-gu, Seoul",
                "region": "KR",
                "province": "Seoul",
                "district": "Mapo District"
              },
              "nationality": "CN",
              "userPhoneNo": "01012345678",
              "certificate": {
                "certificateNo": "11234578899",
                "certificateType": "PASSPORT",
                "certificateIssuingCountry": ""
              },
              "userName": {
                "firstName": "William",
                "lastName": "Clinton",
                "fullName": "William Jefferson Clinton",
                "middleName": "Jefferson"
              },
              "userId": "123456789",
              "birthDate": "20020604",
              "title": "",
              "gender": "",
              "birthPlace": "",
              "politicalExposedPerson": "",
              "occupation": "",
              "userPhoneAreaCode": "",
              "userPhoneExtension": "",
              "email": "williamjclinton@gmail.com"
            },
            "transferToRegion": "ID"
          }
        },
        "accessToken" : "fa8sjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a"
    }
}
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

sessionId
string
1 - 25 characters
Session identifier
customerNumber
string
1 - 32 characters
Customer account number, in format 628xxx
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
additionalInfo
json object
Additional information
Content-type: application/json
X-TIMESTAMP: 2020-12-21T14:36:19+07:00

{
    "responseCode": "2003800",
    "responseMessage": "Successful",
    "referenceNo": "2020102977770000000009",
    "partnerReferenceNo": "2020102900000000000001",
    "sessionId": "883737GHY8839",
    "customerNumber": "628187366363",
    "amount": {
        "value": "10000.00",
        "currency": "IDR"
    },
    "additionalInfo": {}
}
ResponseCauseSolution
2003800Successful
Success to be processed
Mark Customer Top Up process as Success
4003800Bad Request
General request failed error
Mark Customer Top Up process as Failed. Retry request with proper parameter
4003801Invalid Field Format
Invalid format for certain field
Mark Customer Top Up process as Failed. Retry request with proper parameter
4003802Invalid Mandatory Field
Missing or invalid format on mandatory field
Mark Customer Top Up process as Failed. Retry request with proper parameter
4013800Unauthorized. [reason]
General unauthorized error
Mark Customer Top Up process as Failed. Retry request with proper parameter
4013801Invalid Token (B2B)
Authorization token are invalid, perhaps due to token expiry for B2B
Mark Customer Top Up process as Failed. Retry request with proper parameter
4013802Invalid Customer Token
Customer token are invalid, perhaps due to token expiry
Mark Customer Top Up process as Failed. Retry request with proper parameter
4013804Customer Token Not Found
Customer token not found in the system. This occurs on any API that requires token as input parameter
Mark Customer Top Up process as Failed. Retry request with proper parameter
4033802Exceeds Transaction Amount Limit
Exceeds transaction amount limit
Mark Customer Top Up process as Failed. Retry request with proper amount
4033803Suspected Fraud
Suspected fraud
Mark Customer Top Up process as Failed. Contact DANA to check the user/account status
4033805Do Not Honor
Account or user status is abnormal
Mark Customer Top Up process as Failed. Contact DANA to check the user/account status
4033814Insufficient Funds
Insufficient funds
Mark Customer Top Up process as Failed. Contact DANA to top up deposit balance
4033815Transaction Not Permitted.[reason]
Transaction not permitted
Mark Customer Top Up process as Failed. Contact DANA to check merchant configuration
4033818Inactive Card/Account/Customer
Indicates inactive account
Mark Customer Top Up process as Failed. Contact DANA to check merchant configuration
4033820Merchant Limit Exceed
Merchant aggregated purchase amount on that day exceeds the agreed limit
Mark Customer Top Up process as Failed. Contact DANA to check merchant configuration
4043808Invalid Merchant
Merchant does not exist or status abnormal
Mark Customer Top Up process as Failed. Contact DANA to check merchant configuration
4043811Invalid Card/Account/Customer [info]/Virtual Account
Card information may be invalid, or the card account may be blacklisted, or Virtual Account number maybe invalid
Mark Customer Top Up process as Failed. Contact to DANA to check merchant configuration
4043818Inconsistent Request
Inconsistent request parameter found for the same partner reference number/transaction identifier
Mark Customer Top Up process as Success. Contact DANA to check the Customer Top Up process status
4293800Too Many Requests
Maximum transaction limit exceeded
Mark Customer Top Up process as Pending. Hold the money and retry request periodically
5003800General Error
General error non retry-able
Mark Customer Top Up process as Failed. Retry new Customer Top Up process
5003801Internal Server Error
Unknown internal server failure, please retry the process again
Mark Customer Top Up process as Pending. Hold the money and retry request periodically
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, if still fails mark Customer Top Up process as Pending and hold the money
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 Customer Top Up process as Pending
  • If empty field/field does not exist, mark Customer Top Up 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.