Refund - Auth Payment

Specification

The Following tabel is spesification for this API :

API Name	Refund - Auth Payment
Function	This API is used to request refund payment user paydia base on auth payment
Service Code	69
Method	POST
URL	/snap/v1.0/auth/refund
Accept	application/json
Content Type	application/json
Related Service	Auth Payment

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	Authorization-Customer	String	Variable, 64 max	Mandatory	-	Contains customer token, you've got it from Access Token B2B2C
4	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)
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)
8	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	originalPartnerReferenceNo	String	Variable, 64 max	Mandatory	-	Original transaction identifier on partner system
2	originalReferenceNo	String	Variable, 64 max	Optional	-	Original transaction identifier on Paydia system. Must be filled upon successful transaction
3	partnerRefundNo	String	Variable, 64 max	Mandatory	-	Unique refund identifier on partner system which assigned to each transaction
4	originalCaptureNo	String	Variable, 64 max	Optional	-	Original capture identifier on Paydia system. Must be filled upon successful transaction
5	merchantId	String	Variable, 64 max	Mandatory	-	Merchant identifier that is unique per each merchant
6	refundAmount	Money	Variable	Mandatory	-	Contains two sub-fields: Value: Transaction amount, including the cents Currency: Currency code based on ISO
7	reason	String	Variable, 256 max	Mandatory	-	Refund reason

Request Sample

The following script is a request sample of this API:

POST /snap/v1.0/auth/refund
Authorization-Customer: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE3MjQxMjI3NjIsImV4cCI6MTczOTg5MDc2MiwianRpIjoiNjY1NzAzNTRjZDQ1Mjk5YTAwYTE5NjU3OGI5MmJlZjgzNGVkNGUwZGQ1OGVjZjk0YWI1MjhiMzMxOTYyMTFhMiIsImNsaWVudF9pZCI6ImRVVT0iLCJtZXJjaGFudF9taWQiOiJja1FFU2xZR0JBSUJBZ0p3UUFSSiIsInNjb3BlIjoiUFVCTElDX0lEIiwic3RhdGUiOiI0NWMzOTc2Mi0zZDgzLTRjYTktYWRlYi00YzU1NjAwNWY2ZjIifQ.bskQVeyZD43hCXaWNaNcrSM_6A5wrSbTrJrGkpGiqno
X-TIMESTAMP: 2024-08-20T07:31:05+07:00
X-PARTNER-ID: 4abbcb6ce30229994c76169006e0dc9c
X-SIGNATURE: vr89lwkQbAc3jt0P+kn2mFLX7997HiVrwKzyW/oZpAQBnz3M9GznGqpn+Z6mMup/Y2BsMZ64mUePtqxwanAVnw==
X-EXTERNAL-ID: 1724139162
CHANNEL-ID: 12345
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE3MjQxMjI2NzgsImV4cCI6MTcyNDIwOTA3OCwiZGF0YSI6eyJlbnYiOiJwcm9kdWN0aW9uIn19.qejS3HEFtioUn0fZ5txN2Vr1o_fHF_GWYd1H5a3ePAk

{
    "originalPartnerReferenceNo": "b57d8895-790b-4da3-a9e7-0387176de9bf",
    "originalReferenceNo": "c407177ce0842a3fc0f1b11d06c3a9620f48b71cf7ed255b1f2edc3de175798a",
    "partnerRefundNo": "769ad65f-f7d9-40a5-b56c-64695712f8ac",
    "merchantId": "240327001000000",
    "originalCaptureNo": "9329a97c-1179-4a29-a1e5-be3906b744f7",
    "refundAmount": {
        "value": "7000.00",
        "currency": "IDR"
    },
    "reason": "Customer complain"
}

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	originalReferenceNo	String	Variable, 64 max	Mandatory	-	Original transaction identifier on Paydia system. Must be filled upon successful transaction
4	originalCaptureNo	String	Variable, 64 max	Optional	-	Original capture identifier on Paydia system. Must be filled upon successful transaction
5	originalPartnerReferenceNo	String	Variable, 64 max	Mandatory	-	Original transaction identifier on partner system
6	refundNo	String	Variable, 64 max	Mandatory	-	Refund identifier on Paydia
7	partnerRefundNo	String	Variable, 64 max	Mandatory	-	Unique refund identifier on partner system which assigned to each transaction
8	refundAmount	Money	Variable	Mandatory	-	Amount. Contains two sub-fields: Value: Transaction amount, including the cents Currency: Currency code based on ISO
9	refundTime	String	Fixed, 25 max	Mandatory	-	Time of refund, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)

Response Sample

The following script is a response sample of this API:

{
    "responseCode": "2006900",
    "responseMessage": "Request has been processed successfully",
    "originalReferenceNo": "c407177ce0842a3fc0f1b11d06c3a9620f48b71cf7ed255b1f2edc3de175798a",
    "originalCaptureNo": "9329a97c-1179-4a29-a1e5-be3906b744f7",
    "originalPartnerReferenceNo": "b57d8895-790b-4da3-a9e7-0387176de9bf",
    "partnerRefundNo": "769ad65f-f7d9-40a5-b56c-64695712f8ac",
    "refundNo": "1fc13d90935a42b5a0f9d4041a1b281bfc6420f1229eb7463cd0e2be38e29bfa",
    "refundAmount": {
        "value": "7000.00",
        "currency": "IDR"
    },
    "refundTime": "2024-08-20T14:31:13-07:00"
}

Response Code and Message

The following table is the list response code and message of Direct Debit Payment API:

No	Response Code	Response Message	Remarks
1	2006900	Request has been processed successfully	Success
2	4006901	Invalid Field Format	Invalid format for certain field
3	4006902	Invalid Mandatory Field	Missing or invalid format on mandatory field
4	4016900	Unauthorized [reason]	General unauthorized error
5	4016901	Invalid Token (B2B)	Authorization token are invalid, perhaps due to token expiry for B2B
6	4036914	Insufficient Funds	Insufficient fund to do refund
7	4036915	Transaction Not Permitted.	Transaction Not Permitted
8	4036923	Account Limit Exceed	Account aggregated purchase amount on that day exceeds the agreed limit
9	4046900	Invalid Transaction Status	Invalid transaction status
10	4046901	Transaction Not Found	Transaction not found
11	4046908	Invalid Merchant	Merchant does not exist or status abnormal
12	4046913	Invalid Amount	Invalid amount to do refund
13	4056901	Requested Opearation Is Not Allowed	Requested operation to cancel/refund transaction Is not allowed at this time.
14	5006901	Internal Server Error	500 internal server error