Enquire Payment Method Details
Check the status and the details of the saved payment methods. Parse in the unique consentId and PayNet will return the corresponding consent details.
Process Flow
Step | Sender | Receiver | Process |
---|---|---|---|
1 | Acquirer | API Gateway | Acquirer initiates an enquiry via checkoutId or consentId for the details of the consent. |
2 | API Gateway | Acquirer | API Gateway will locate the consent details and response back to acquirer. |
Request
GET /v1/bw/consent?consentId=M00002010012700006
consentId | String | Max length: 35 | Required | |||
Consent that is authorized for AutoDebit payment received from the webhook Update Consent Details. |
Response
Data Object | ||||||
messageId | String | Max length: 35 | Required | |||
Unique message identification from RPP. This can be used to reconcile with RPP BackOffice or Reports. | ||||||
Consent Object | ||||||
consentId | String | Max length: 35 | Required | |||
Consent that is authorized for AutoDebit payment. | ||||||
consentStatus | String | Max length: 4 | Required | |||
The status of the consent. Please refer to the list of consent status. | ||||||
effectiveDate | String | Max length: 10 | Required | |||
Consent effective date in YYYY-MM-DD format. | ||||||
expiryDate | String | Max length: 10 | Required | |||
Consent expiry date in YYYY-MM-DD format. | ||||||
frequency | String | Max length: 2 | Required | |||
Frequency mode: 01 - Unlimited 02 - Daily 03 - Weekly 04 - Monthly 05 - Quarterly 06 - Yearly | ||||||
allowTerminatedByDebtor | String | Max length: 5 | Required | |||
Consent is allowed to be terminated by payer. It will always default to false. | ||||||
End Consent Object | ||||||
issuer | String | Max length: 100 | Required | |||
Name of payer’s issuing bank / wallet. | ||||||
End Data Object | ||||||
message | String | Max length: 1024 | Required | |||
Please refer to the list of reason codes. |
Sample Response:
{
"data": {
"messageId": "20240517M0037091752OBW04934683",
"consent": {
"consentId": "M00002010012700006",
"consentStatus": "ACTV",
"effectiveDate": "2024-01-24",
"expiryDate": "2024-04-24",
"frequency": "01",
"allowTerminatedByDebtor": "false"
},
"issuer": "Affin Bank"
},
"message": "U000"
}