Delete VA

Specification

The Following tabel is spesification for this API :

API Name	Delete VA
Function	This API is used to delete virtual account (VA) that has been created
Service Code	31
Method	POST
URL	/snap/v1.0/transfer-va/delete-va
Accept	application/json
Content Type	application/json
Related Service	Virtual Account

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	partnerServiceId	String	Fixed, 8 max	Mandatory	-	Biller/merchant code of the virtual account. Left padding with space
2	customerNo	String	Variable, 20 max	Mandatory	-	Unique number (up to 20 digits). Combine partnerServiceId and customerNo or virtualAccountNo
3	virtualAccountNo	String	Variable, 28 max	Mandatory	-	Information of virtual account number which combine partnerServiceId and customerNo

Request Sample

The following script is a request sample of this API:

POST /snap/v1.0/transfer-va/delete-va
X-TIMESTAMP: 2024-10-11T13:33:40+07:00
X-PARTNER-ID: 35d1a1127182a65e4fe0256242a40a6d
X-SIGNATURE: w4LGSK5RddiZ3DQepBtLXQLM8K3lNFJ15MP/hqtbzDBMP4nLPM/C1feXyuXT01tEEubxIQDpNMygefxXFP0fow==
X-EXTERNAL-ID: 1728628603
CHANNEL-ID: 702
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE3Mjg2MjgwMTAsImV4cCI6MTcyODcxNDQxMCwiZGF0YSI6eyJlbnYiOiJkZXZlbG9wbWVudCJ9fQ.8iufVrkcqA_l2IfP4d9OPaSQb8CU9Dyal-n0e8dDLpg

{
    "partnerServiceId": "  359660",
    "customerNo": "70627627784739813500",
    "virtualAccountNo": "  35966070627627784739813500",
    "additionalInfo": {}
}

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	virtualAccountData	JSON Object	Variable	Mandatory	-	Contains virtual account data

Response Sample

The following script is a response sample of this API:

{
    "responseCode": "2002700",
    "responseMessage": "Successful",
    "virtualAccountData": {
        "partnerServiceId": "  359660",
        "customerNo": "70627627784739813500",
        "virtualAccountNo": "  35966070627627784739813500",
        "additionalInfo": {}
    }
}

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	2003100	Successful	Success to be processed
2	4003101	Invalid Field Format	Invalid format for certain field
3	4003102	Invalid Mandatory Field	Missing or invalid format on mandatory field
4	4013100	Unauthorized. [reason]	General unauthorized error
5	4013101	Invalid Token (B2B)	Invalid or Expired Access Token
6	4043112	Invalid Bill/Virtual Account	The bill is blocked/ suspended/not found Virtual account is suspend/not found
7	4093100	Conflict	Cannot use same X-EXTERNAL-ID in same day
8	4093101	Duplicate partnerReferenceNo	Duplicate partnerReferenceNo
9	5003102	Backend system failure	500 internal server error