Account Inquiry

Specification

The Following tabel is spesification for this API :

API Name	Account Inquiry
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	Conditional	If the signature option is asymmetric approach	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-SIGNATURE	String	Variable	Mandatory	-	Signature will be generated automatically with symmetricSignature or asymmetricSignature method
5	X-PARTNER-ID	String	Variable, 36 max	Mandatory	-	ID for partner was generated by Paydia. Unique ID for a partner
6	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
7	CHANNEL-ID	String	Variable, 5 max	Mandatory	-	Device identification on which the API services is currently being accessed by the end user (customer)

Body

The following table is a body of request parameter:

No	Name	Type	Length	Required	Condition	Remarks
1	partnerReferenceNo	String	Variable, 64 max	Mandatory	-	Transaction identifier on service consumer system
2	amount	Money	Variable	Mandatory	-	Contains two sub-fields: Value: Transaction amount, including the cents Currency: Currency code based on ISO
3	beneficiaryAccountNumber	String	Variable, 32 max	Mandatory	-	Destination account number
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 HTTP/1.1
X-Timestamp: 2023-06-20T13:37:23+07:00
X-Signature: VcyXz6UE7QMpTU6CO6CnZLt1ns1htNrxLhEgO731lhIB401B69fIRVEN5nJBHwUp2djvIeuQAcN/o2fmhDWmmg==
X-Partner-Id: 8f548c9c439139b2285269e56db6b8ed
X-External-Id: 1687243078
Channel-Id: 128
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE2ODcyNDMwMzksImV4cCI6MTY4NzI0MzkzOX0.S3BZ0EPoMar1XE3l3aeKKkeGS5JjXYdLs1jXZYGAqLU
{
    "partnerReferenceNo": "9d694c08-4889-40f6-8160-b51099fbc2fb",
    "amount": {
        "value": "10000.00",
        "currency": "IDR"
    },
    "beneficiaryAccountNumber": "0123456789",
    "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 system
4	partnerReferenceNo	String	Variable, 64 max	Mandatory	-	Transaction identifier on partner system
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	Mandatory	-	Amount. Contains two sub-fields: Value: Transaction amount, including the cents Currency: Currency code based on ISO
10	additionalInfo	JSON Object	Variable	Mandatory	-	Additional information
11	additionalInfo.balance	Money	Variable	Mandatory	-	Additional information of merchant's balance. Contains two sub-fields: Value: Transaction amount, including the cents Currency: Currency code based on ISO

Response Sample

The following script is a response sample of this API:

{
  "responseCode": "2004200",
  "responseMessage": "Successful",
  "referenceNo": "23061658ubdl6",
  "partnerReferenceNo": "31fa58e9-ca5b-4e72-aa6d-566464922278",
  "beneficiaryAccountNumber": "0123456789",
  "beneficiaryAccountName": "John Doe",
  "beneficiaryBankCode": "014",
  "beneficiaryBankName": "PT Bank Central Asia Tbk",
  "amount": {
    "value": "10000.00",
    "currency": "IDR"
  },
  "additionalInfo": {
    "balance": {
      "value": "500000.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	Unauthorized [Invalid Authorization]	Access token expiry
6	4014201	Invalid Token	Token found in request is invalid (Access Token Not Exist, Access Token Expiry)
7	4044203	Bank Not Supported By Switch	Bank not supported by switch
8	4044211	Invalid Account	Destination account number
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