Transfer to Bank
POST/v1.0/emoney/transfer-bank.htm
This API is used for merchant to do transfer to Bank request via DANA.
API Type
SNAP API
Expected Timeout
8 second
SNAP Service Code
43
Accept
application/json
Content Type
application/json
Content-type
string
1 - 127 charactersRequiredContent type, value always
application/jsonAuthorization
string
1 - 2048 charactersConditionalContains 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 charactersRequiredTransaction date time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
X-SIGNATURE
string
RequiredSignature need to be generated with
symmetricSignature or asymmetricSignature methodORIGIN
string
Origin domain
X-PARTNER-ID
string
1 - 36 charactersRequiredUnique identifier for partner was generated by DANA, or known as clientId
X-EXTERNAL-ID
string
1 - 36 charactersRequiredUnique messaging reference identifier generated by merchant and should be unique within the same day
X-IP-ADDRESS
string
15 charactersIP address of the end user (customer) using IPv4 format
X-DEVICE-ID
string
1 - 400 charactersConditionalDevice identification on which the API services is currently being accessed by the end user (customer)
Sample:
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 charactersRequiredDevice identification on which the API services is currently being accessed by the end user (customer)
partnerReferenceNo
string
1 - 64 charactersRequiredUnique 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 charactersCustomer account number, in format 628xxx
accountType
string
1 - 32 charactersRequiredCustomer account type
beneficiaryAccountNumber
string
1 - 32 charactersRequiredBeneficiary’s account number
beneficiaryBankCode
string
1 - 8 charactersRequiredBeneficiary’s Bank identifier code
amount
money
RequiredAmount. Contains two sub-fields:
- Value: Transaction amount, including the cents
- Currency: Currency code based on ISO, always has value:
IDR
value
string
1 - 19 charactersRequiredValue 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
e.g., IDR 10.000,- will be placed with 10000.00
currency
string
1 - 3 charactersRequiredCurrency
additionalInfo
json object
Additional information
additionalInfo.fundType
string
1 - 64 charactersRequiredAdditional information of top up fund type, value always
MERCHANT_WITHDRAW_FOR_CORPORATEadditionalInfo.externalDivisionId
string
1 - 64 charactersAdditional information of external division identifier.
(fundType:
(fundType:
MERCHANT_WITHDRAW_FOR_CORPORATE)Note
It is generally optional, but becomes mandatory if the additionalInfo.chargeTarget value is set to DIVISION.
additionalInfo.chargeTarget
string
1 - 64 charactersAdditional information of charge target. The values are:
nullDIVISIONMERCHANT
Note
If the value is DIVISION, externalDivisionId will be Mandatory
additionalInfo.needNotify
boolean
Additional information of flag result notification on transaction completed (result sync/async)
additionalInfo.subScenario
string
1 - 64 charactersConditionalAdditional information of sub scenario, value always
GLOBAL_REMITTANCEConditional Info
Y:= Cross border remittance scenario
additionalInfo.beneficiaryAccountName
string
1 - 128 charactersAdditional information of beneficiary account name for validation purpose
additionalInfo.extendInfo
json object
1 - 4096 charactersAdditional information of extend
additionalInfo.extendInfo.instructedAmountType
string
1 - 64 charactersAdditional information of type of instructed amount
additionalInfo.extendInfo.payerPaymentMethod
json object
RequiredAdditional information of method of payer payment
walletDetail
json object
ConditionalInformation details of cash/wallet
Conditional Info
Y:=
paymentMethodType=CASH/WALLETwalletName
string
1 - 128 charactersRequiredWallet name
customerId
string
1 - 64 charactersRequiredCustomer unique identifier assigned by participant
customerName
json object
Information details of customer name
customerName.firstName
string
1 - 32 charactersCustomer’s first name
customerName.lastName
string
1 - 32 charactersCustomer’s last name
customerName.fullName
string
1 - 128 charactersRequiredCustomer’s full name
customerName.middleName
string
1 - 32 charactersCustomer’s middle name
paymentMethodType
string
1 - 32 charactersRequiredPayer’s type of payment method, which has values:
WALLETBANKCASH
sourceOfFund
string
1 - 32 charactersFund source, which has values:
SALARYBUSSINESSUNKNOWN
bankDetail
json object
ConditionalInformation details of Bank/cash
Conditional Info
Y:=
paymentMethodType=BANKaccountType
string
1 - 32 charactersType of account
accountNo
string
1 - 64 charactersConditionalAccount number
Conditional Info
Y:=
paymentMethodType=BANKaccountName
string
1 - 128 charactersAccount name
bankName
string
1 - 128 charactersConditionalBank name
Conditional Info
Y:=
paymentMethodType=BANKofficeOpeningAccount
string
1 - 128 charactersThe Bank of account opening
swiftCode
string
1 - 16 charactersConditionalBank identifier code for cross-border financial transactions
Conditional Info
Y:=
paymentMethodType=BANKcurrency
string
1 - 3 charactersCurrency, always has value:
IDRiban
string
1 - 64 charactersAn international Bank account code to identify offshore bank accounts
additionalInfo.extendInfo.bizSceneType
string
1 - 64 charactersAdditional information of type of Bizscene
additionalInfo.extendInfo.transferToAmount
money
Additional information of transfer to amount. Contains two sub-fields:
- Value: Amount, including the cents
- Currency: Currency code based on ISO, always has value:
IDR
value
string
1 - 19 charactersRequiredValue 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
e.g., IDR 10.000,- will be placed with 10000.00
currency
string
1 - 3 charactersRequiredCurrency
additionalInfo.extendInfo.transferFromAmount
money
Additional information of transfer from amount. Contains two sub-fields:
- Value: Amount, including the cents
- Currency: Currency code based on ISO, always has value:
IDR
value
string
1 - 19 charactersRequiredValue 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
e.g., IDR 10.000,- will be placed with 10000.00
currency
string
1 - 3 charactersRequiredCurrency
additionalInfo.extendInfo.additionalTransferDetails
json object
Additional information of transfer details
beneficiary
json object
RequiredBeneficiary user information
nationality
string
2 charactersCode of nationality. Refer to ISO-3166 country/region code. Always has value:
ID (Indonesia)userName
json object
Information details of user name
userName.firstName
string
1 - 32 charactersUser’s first name
userName.lastName
string
1 - 32 charactersUser’s last name
userName.fullName
string
1 - 128 charactersRequiredUser’s full name
userName.middleName
string
1 - 32 charactersUser’s middle name
transferPurpose
string
1 - 32 charactersType of transfer purpose, such as:
FAMILY_SUPPORTSALARYEDUCATIONOTHER
transferFromRegion
string
2 charactersRequiredPayer’s country or region. Refer to ISO-3166 country/region code
payer
json object
RequiredInformation details of payer
userAddress
json object
RequiredInformation detail of user address
userAddress.zipCode
string
1 - 32 charactersZIP or postal code of user
userAddress.city
string
1 - 32 charactersRequiredCity, district, suburb, town, or village
userAddress.address2
string
1 - 256 charactersAddress line 2
userAddress.address1
string
1 - 256 charactersAddress line 1
userAddress.region
string
2 charactersRequiredCode of region. Refer to ISO-3166 country/region code
userAddress.province
string
1 - 32 charactersUser’s address province
userAddress.district
string
1 - 32 charactersUser’s address district
nationality
string
2 charactersPayer’s nationality code. Refer to ISO-3166 country/region code
certificate
json object
Information details of certificate
certificate.certificateNo
string
1 - 64 charactersRequiredPayer’s identity certificate number, if not available, can use the passport
certificate.certificateType
string
1 - 32 charactersType of certificate, which has values:
ID_CARDPassport
certificate.certificateIssuingCountry
string
1 - 2 charactersPayer's certificate issuance country. Refer to ISO-3166 country/region code
userName
json object
Information details of user name
userName.firstName
string
1 - 32 charactersUser’s first name
userName.lastName
string
1 - 32 charactersUser’s last name
userName.fullName
string
1 - 128 charactersRequiredUser’s full name
userName.middleName
string
1 - 32 charactersUser’s middle name
userId
string
1 - 64 charactersUnique user identifier
birthDate
string
1 - 8 charactersDate of birth. Formatted in
YYYYMMDDtitle
string
1 - 8 charactersUser’s title, which has values:
MRMRSMS
gender
string
1 - 16 charactersUser’s gender, which has values:
MALEFEMALE
birthPlace
string
1 - 64 charactersPayer’s birthplace
politicalExposedPerson
string
1 charactersA Politically Exposed Person (PEP) options, which has values:
YN
occupation
string
1 - 64 charactersPayer’s occupation
userPhoneNo
string
1 - 32 charactersRequiredPayer’s contact number
userPhoneAreaCode
string
1 - 8 charactersPayer’s phone area code
userPhoneExtension
string
1 - 8 charactersPayer’s phone extension
email
string
1 - 128 charactersPayer’s email
transferToRegion
string
2 charactersRequiredBeneficiary’s country or region. Refer to ISO-3166 country/region code. Always has value:
ID (Indonesia)additionalInfo.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
Payment Method is Wallet
POST .../v1.0/emoney/transfer-bank.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",
"accountType": "SETTLEMENT_ACCOUNT",
"beneficiaryAccountNumber": "01234567890",
"beneficiaryBankCode": "002",
"amount":
{
"value": "10000.00",
"currency": "IDR"
},
"additionalInfo":
{
"fundType": "MERCHANT_WITHDRAW_FOR_CORPORATE",
"externalDivisionId": "91080916Division",
"chargeTarget": "DIVISION",
"subScenario": "GLOBAL_REMITTANCE",
"beneficiaryAccountName": "Holder Name",
"extendInfo":
{
"payerPaymentMethod":
{
"walletDetail":
{
"walletName": "HK_WALLET",
"customerId": "123456789",
"customerName":
{
"firstName": "William",
"lastName": "Clinton",
"fullName": "William Jefferson Clinton",
"middleName": "Jefferson"
}
},
"paymentMethodType": "WALLET",
"sourceOfFund": ""
},
"instructedAmountType": "TRANSFER_TO",
"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 charactersRequiredContent type, value always
application/jsonX-TIMESTAMP
string
25 charactersRequiredTransaction date time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
responseCode
string
7 charactersRequiredRefer to response code list
responseMessage
string
1 - 150 charactersRequiredRefer to response code list
referenceNo
string
1 - 64 charactersConditionalTransaction identifier on DANA system
Conditional Info
Y:= Successfully processed
partnerReferenceNo
string
1 - 64 charactersRequiredUnique 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
transactionDate
string
25 charactersTransaction date, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
referenceNumber
string
1 - 64 charactersRequiredReference number
additionalInfo
json object
Additional information
Content-type: application/json
X-TIMESTAMP: 2020-12-21T14:36:19+07:00
{
"responseCode": "2004300",
"responseMessage": "Successful",
"referenceNo": "2020102977770000000009",
"partnerReferenceNo": "2020102900000000000001",
"transactionDate": "2020-12-21T17:48:41+07:00",
"referenceNumber": "2020102977770000000009",
"additionalInfo": {
}
}
| Response | Cause | Solution |
|---|---|---|
2004300Successful | Success to be processed | Mark Transfer to Bank process as Success |
2024300Request In Progress | Transaction is on process | Mark Transfer to Bank process as Pending. Hold the money and wait notify |
4004300Bad Request | General request failed error | Mark Transfer to Bank process as Failed. Retry request with proper parameter |
4004301Invalid Field Format | Invalid format for certain field | Mark Transfer to Bank process as Failed. Retry request with proper parameter |
4004302Invalid Mandatory Field | Missing or invalid format on mandatory field | Mark Transfer to Bank process as Failed. Retry request with proper parameter |
4014300Unauthorized. [reason] | General unauthorized error | Mark Transfer to Bank process as Failed. Retry request with proper parameter |
4014301Invalid Token (B2B) | Authorization token are invalid, perhaps due to token expiry for B2B | Mark Transfer to Bank process as Failed. Retry request with proper parameter |
4014302Invalid Customer Token | Customer token are invalid, perhaps due to token expiry | Mark Transfer to Bank process as Failed. Retry request with proper parameter |
4014304Customer Token Not Found | Customer token not found in the system. This occurs on any API that requires token as input parameter | Mark Transfer to Bank process as Failed. Retry request with proper parameter |
4034302Exceeds Transaction Amount Limit | Exceeds transaction amount limit | Mark Transfer to Bank process as Failed. Retry request with proper amount |
4034303Suspected Fraud | Suspected fraud | Mark Transfer to Bank process as Failed. Contact DANA to check the user/account status |
4034314Insufficient Funds | Insufficient funds | Mark Transfer to Bank process as Failed. Contact DANA to top up deposit balance |
4034318Inactive Card/Account/Customer | Indicates inactive account | Mark Transfer to Bank process as Failed. Contact DANA to check merchant configuration |
4034320Merchant Limit Exceed | Merchant aggregated purchase amount on that day exceeds the agreed limit | Mark Transfer to Bank process as Failed. Contact DANA to check merchant configuration |
4044303Bank Not Supported By Switch | Bank not supported by switch | Mark Transfer to Bank process as Failed. Retry new Transfer to Bank process with different Bank target |
4044311Invalid 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 Transfer to Bank process as Failed. Retry request with proper Bank account info |
4044318Inconsistent Request | Inconsistent request parameter found for the same partner reference number/transaction identifier | Mark Transfer to Bank process as Success. Contact DANA to check status of Transfer to Bank process |
4294300Too Many Requests | Maximum transaction limit exceeded | Mark Transfer to Bank process as Pending. Hold the money and retry request periodically |
5004300General Error | General error non retry-able | Mark Transfer to Bank process as Failed. Retry new Transfer to Bank process |
5004301Internal Server Error | Unknown internal server failure, please retry the process again | Mark Transfer to Bank 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 Transfer to Bank 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) |
|