Skip to main content

Auth Payment

Specification

The Following tabel is spesification for this API :

API NameAuth Payment
FunctionThis API is used to initiate payment from user to merchant Paydia
Service Code63
MethodPOST
URL/snap/v1.0/auth/payment
Acceptapplication/json
Content Typeapplication/json
Related ServiceAuth 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:

The following table is Header of Request Parameters :

NoNameTypeLengthRequiredConditionRemarks
1Content-TypeStringVariable, 127 maxMandatory-Content type, value always application/json
2AuthorizationStringVariableMandatory-Contains B2B Bearer JWT Token, you've got it from Access Token B2B
3Authorization-CustomerStringVariable, 64 maxMandatory-Contains customer token, you've got it from Access Token B2B2C
4X-TIMESTAMPStringFixed, 25 maxMandatory-Transaction date time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time)
5X-PARTNER-IDStringVariable, 36 maxMandatory-ID for partner was generated by Paydia. Unique ID for a partner
6X-EXTERNAL-IDStringVariable, 36 maxMandatory-Unique messaging reference ID generated by merchant. Numeric String. Reference number that should be unique in the same day
7CHANNEL-IDStringVariable, 5 maxMandatory-Device identification on which the API services is currently being accessed by the end user (customer)
8X-SIGNATUREStringVariableMandatory-Signature need to be generated with Symmetric Signature method

Body

The following table is a body of request parameter:

NoNameTypeLengthRequiredConditionRemarks
1partnerReferenceNoStringVariable, 64 maxMandatory-Unique transaction identifier on partner system which assigned to each transaction
2merchantIdStringVariable, 64 maxMandatory-Merchant identifier that is unique per each merchant
3amountMoneyVariableMandatory-Contains two sub-fields:
  1. Value: Transaction amount, including the cents
  2. Currency: Currency code based on ISO
4titleStringVariable, 256 maxMandatory-Order title

Request Sample

The following script is a request sample of this API:

POST /snap/v1.0/auth/payment
Authorization-Customer: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE3MjQxMjI3NjIsImV4cCI6MTczOTg5MDc2MiwianRpIjoiNjY1NzAzNTRjZDQ1Mjk5YTAwYTE5NjU3OGI5MmJlZjgzNGVkNGUwZGQ1OGVjZjk0YWI1MjhiMzMxOTYyMTFhMiIsImNsaWVudF9pZCI6ImRVVT0iLCJtZXJjaGFudF9taWQiOiJja1FFU2xZR0JBSUJBZ0p3UUFSSiIsInNjb3BlIjoiUFVCTElDX0lEIiwic3RhdGUiOiI0NWMzOTc2Mi0zZDgzLTRjYTktYWRlYi00YzU1NjAwNWY2ZjIifQ.bskQVeyZD43hCXaWNaNcrSM_6A5wrSbTrJrGkpGiqno
X-TIMESTAMP: 2024-08-20T03:48:09+07:00
X-PARTNER-ID: 4abbcb6ce30229994c76169006e0dc9c
X-SIGNATURE: OCxa001qRQflvr/jilpe3JfETFa6pBIDW7e3FBkSugmJZo1H6+KUb7zt5bthxH3HDFmP1/wogt1V34bWu4DBJg==
X-EXTERNAL-ID: 1724125701
CHANNEL-ID: 12345
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE3MjQxMjI2NzgsImV4cCI6MTcyNDIwOTA3OCwiZGF0YSI6eyJlbnYiOiJwcm9kdWN0aW9uIn19.qejS3HEFtioUn0fZ5txN2Vr1o_fHF_GWYd1H5a3ePAk

{
"partnerReferenceNo": "b57d8895-790b-4da3-a9e7-0387176de9bf",
"merchantId": "240327001000000",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"title": "Payment"
}

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:

NoNameTypeLengthRequiredConditionRemarks
1responseCodeStringFixed, 7 maxMandatory-Refer to response code list
2responseMessageStringVariable, 150 maxMandatory-Refer to response code list
3referenceNoStringVariable, 64 maxMandatory-Transaction identifier on Paydia
4partnerReferenceNoStringVariable, 64 maxMandatory-Unique transaction identifier on partner system which assigned to each transaction
5amountMoneyVariableMandatory-Amount. Contains two sub-fields:
  1. Value: Transaction amount, including the cents
  2. Currency: Currency code based on ISO
6paidTimeStringFixed, 25 maxMandatory-Time of paid, 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": "2006300",
"responseMessage": "Request has been processed successfully",
"referenceNo": "c407177ce0842a3fc0f1b11d06c3a9620f48b71cf7ed255b1f2edc3de175798a",
"partnerReferenceNo": "b57d8895-790b-4da3-a9e7-0387176de9bf",
"amount": {
"value": "10000.00",
"currency": "IDR"
},
"paidTime": "2024-08-20T10:48:15-07:00"
}

Response Code and Message

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

NoResponse CodeResponse MessageRemarks
12006300Request has been processed successfullySuccess
24006301Invalid Field FormatInvalid format for certain field
34006302Invalid Mandatory FieldMissing or invalid format on mandatory field
44016300Unauthorized. [reason]General unauthorized error
54016301Invalid Token (B2B)Invalid or Expired Access Token
64036302Exceeds Transaction Amount LimitMinimum or maximum amount limit
74036314Insufficient FundsInsufficient Funds
84046308Invalid MerchantMerchant does not exist or status abnormal
94096300ConflictCannot use same X-EXTERNAL-ID in same day
104096301Duplicate partnerReferenceNoDuplicate partnerReferenceNo
115006301Internal Server Error500 internal server error