Account Inquiry - Transfer to Bank
Specification
The Following tabel is spesification for this API :
API Name | Account Inquiry - Transfer to Bank |
---|---|
Function | This API is used for merchant to do inquiry Bank account info via Paydia Bisnis |
Service Code | 42 |
Method | POST |
URL | /snap/v1.0/emoney/bank-account-inquiry |
Accept | application/json |
Content Type | application/json |
Related Service | Transfer to Bank |
Request
The following part will be describe about parameter of request in this API:
Request Parameter
The following table is a list of request parameter in this API:
Header
The following table is Header of Request Parameters :
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | Content-Type | String | Variable, 127 max | Mandatory | - | Content type, value always application/json |
2 | Authorization | String | Variable | Mandatory | - | Contains B2B Bearer JWT Token, you've got it from Access Token B2B |
3 | X-TIMESTAMP | String | Fixed, 25 max | Mandatory | - | Transaction date time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time) |
4 | X-PARTNER-ID | String | Variable, 36 max | Mandatory | - | ID for partner was generated by Paydia. Unique ID for a partner |
5 | X-EXTERNAL-ID | String | Variable, 36 max | Mandatory | - | Unique messaging reference ID generated by merchant. Numeric String. Reference number that should be unique in the same day |
6 | CHANNEL-ID | String | Variable, 5 max | Mandatory | - | Device identification on which the API services is currently being accessed by the end user (customer) |
7 | X-SIGNATURE | String | Variable | Mandatory | - | Signature need to be generated with Symmetric Signature method |
Body
The following table is a body of request parameter:
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | partnerReferenceNo | String | Variable, 64 max | Mandatory | - | Unique transaction identifier on partner system which assigned to each transaction |
2 | beneficiaryAccountNumber | String | Variable, 32 max | Mandatory | - | Destination account number |
3 | amount | Money | Variable | Optional | - | Contains two sub-fields:
|
4 | additionalInfo | JSON Object | Variable | Mandatory | - | Additional information |
5 | additionalInfo.beneficiaryBankCode | String | Variable, 8 max | Mandatory | - | Additional information of beneficiary Bank code |
Request Sample
The following script is a request sample of this API:
POST /snap/v1.0/emoney/bank-account-inquiry
X-TIMESTAMP: 2024-08-02T23:08:18+07:00
X-PARTNER-ID: 4abbcb6ce30229994c76169006e0dc9c
X-SIGNATURE: wDDkmyZ7Qa02pUKOGLYaASLW8nJ+uY/iQPnzbIalOisgxuRYVVW2Cx4CilB9f9BS4x0A0dKqIp3DEKCMCoPrHQ==
X-EXTERNAL-ID: 1722614914
CHANNEL-ID: 636
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE3MjI2MTQ4OTIsImV4cCI6MTcyMjcwMTI5MiwiZGF0YSI6eyJlbnYiOiJwcm9kdWN0aW9uIn19.l_To-VKXxMqP_fcls6D0JbaLeJX_a1Oq6h59EauNK1s
{
"partnerReferenceNo": "ca901922-9406-43c2-a4e9-04a0266c0e91",
"beneficiaryAccountNumber": "3647075923",
"amount": {
"value": "12000.00",
"currency": "IDR"
},
"additionalInfo": {
"beneficiaryBankCode": "014"
}
}
Response
The following part will be describe about parameter of response in this API:
Response Parameter
The following table is a list of response parameter in this API:
Body
The following table is a body of response parameter:
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | responseCode | String | Fixed, 7 max | Mandatory | - | Refer to response code list |
2 | responseMessage | String | Variable, 150 max | Mandatory | - | Refer to response code list |
3 | referenceNo | String | Variable, 64 max | Optional | - | Transaction identifier on Paydia |
4 | partnerReferenceNo | String | Variable, 64 max | Mandatory | - | Unique transaction identifier on partner system which assigned to each transaction |
5 | beneficiaryAccountNumber | String | Variable, 32 max | Mandatory | - | Beneficiary account number |
6 | beneficiaryAccountName | String | Variable, 64 max | Mandatory | - | Beneficiary account name |
7 | beneficiaryBankCode | String | Variable, 8 max | Mandatory | - | Beneficiary Bank code |
8 | beneficiaryBankName | String | Variable, 25 max | Mandatory | - | Beneficiary Bank name |
9 | amount | Money | Variable | Optional | - | Amount. Contains two sub-fields:
|
10 | additionalInfo | JSON Object | Variable | Mandatory | - | Additional information |
11 | additionalInfo.balance | Money | Variable | Mandatory | - | Additional information of merchant's balance. Contains two sub-fields:
|
Response Sample
The following script is a response sample of this API:
{
"responseCode": "2004200",
"responseMessage": "Successful",
"referenceNo": "d2d2e3ba-9e22-471e-9c09-fe79905a803b",
"partnerReferenceNo": "ca901922-9406-43c2-a4e9-04a0266c0e91",
"beneficiaryAccountNumber": "3647075923",
"beneficiaryAccountName": "Putri Padmasari",
"beneficiaryBankCode": "014",
"beneficiaryBankName": "BANK BCA",
"amount": {
"value": "12000.00",
"currency": "IDR"
},
"additionalInfo": {
"balance": {
"value": "19787531.00",
"currency": "IDR"
}
}
}
Response Code and Message
The following table is the list response code and message of Account Inquiry API:
No | Response Code | Response Message | Remarks |
---|---|---|---|
1 | 2004200 | Successful | Success to be processed |
2 | 4004201 | Invalid Field Format | Invalid format for certain field |
3 | 4004202 | Invalid Mandatory Field | Missing or invalid format on mandatory field |
4 | 4014200 | Unauthorized. [reason] | General unauthorized error |
5 | 4014201 | Invalid Token (B2B) | Invalid or Expired Access Token |
6 | 4034201 | Feature Not Allowed | Feature Not Allowed |
7 | 4044203 | Bank Not Supported By Switch | Bank not supported by switch |
8 | 4044211 | Invalid Account | Destination account invalid |
9 | 4094200 | Conflict | Cannot use same X-EXTERNAL-ID in same day |
10 | 4094201 | Duplicate partnerReferenceNo | Duplicate partnerReferenceNo |
11 | 5004202 | Backend system failure | 500 internal server error |