Whenever a transaction was suspended, you can use the Resume a Payment endpoint to resume that transaction.
APIHosted
API Examples
Resume a 3DSecure v1 suspended payment
POST /acceptor/rest/transactions/{instId}/{transactionId}/resume
{
"threeDSecureResponse": {
"pares": "eJydVVtzokoQfvdXWO5jKhlu3rZGtoaLii4oCip5m8AEMAoICOivP4Mkxt06D6fOlJTd3/R8/XU3F/irOh7aBUmzMI5GHfaF6bRJ5MZeGPmjjm2NnwedXyK0gpQQZU3cc0pEqJMswz5ph96ow3wtluMYlmfYvtDriHCJViS7BbAcL3Rr6DOJSHO8cBB8uZQtdQMc5SLE7knSDHHIMgLDQPDpwiNJNUUU+n2O47t9CBofgu+Dy3NtZVRaFXqirqDyflnaRVfUK714Q3FGENQR0MM5EalegeHZQZsZ/qS/7gCCGw7xMT5TWvZWF9XRuDCps6A/9x4xSLuT0uZdxIm0hODuQVIlcURoBC37bkOPZK64xsfkQNpWiqMMuzltCBVRb0DwXVSCI5H5c3VZfkiz0w1o7USYh8c/62EZWhIENxxmOc7PmehA8GlBFxeFiBCS0HU+c0xqIXW11Q4Bui2J9ukWAokbikwtm/7fTqGDH6dhHhxFton5BiCopYDb6EW4Dv2IJktJm95hUTbqBHme/ASgLMuXkn+JUx9wtBDADAEN8LLQ/9FpThFPi95jEco4iqPQxYfwiuvO6CQPYq99T/hvlNaqZmXBSpWfKe2zywrRc43QxnQ74EHWf2H7W2Ca4ecswGxNtCLvpJ4vadsrbdT5cb/PldAnWf5/6L+oG4YNPpyJeHpbCGic2PuTsHOTyDoVSVqlHu5eEB3SYyQEd0nUfmzkveYm0MOOf/Td7Fqc9cQWvBXx1tz72h6XVhSpgzTk4zA5B+y8182Xm2O/VyJhupwjM3Rse0Zmi64+AR/biVKu/JbSzReOJm91NBo1WR8ywTm5NBJ2XWao4Bw3lkzSPHyno6VPm65pkm7JEj9HCvJVGfmBcuoL89VgxeVXZEj+xyn4CCfDkpGQaY9pFNFNppRLR9mY5lwtV/brzmBqrPUJ/r6DkrBTLJXRFb1aKKirW6hcbOJPzLkY+ztWTveqoaNsglhblQNdbW0mm6unPICVrjaY5OqImcjr02StvfGKqdbKEGIypKu+bJrya5Jt1n61C6/WacGcirL1tNmD3cXZ9t4GmnEtl4lfFd5g7nIume4H2xl5UnhPxpcrMfLB694eCPakiirB2F6nRrGYkGUvR74u0Qe1bCmmM5vHr1pQuAYy1bFkIsU0UTgoMl/NnbzYJwt1EV7mxwhLylBeC6f+OZk5sydtcf1I8VQ1zIkZeiz3ZrSQg7xSRTPdSbdcOe0/9Qrh5M0qRtWskowJBH+PrEGacYL7iL+Hf3s33z4R9Tvh8dPxD0LXFng="
}
}
HTTP/1.1 201
{
"processing": {
"authResponse": {
"statusCode": "00",
"message": "Approved or completed successfully",
"authCode": "123456",
"gatewayReference": "123546789",
"avsAddressCheck": "FULL_MATCH",
"avsPostcodeCheck": "FULL_MATCH",
"cv2Check": "MATCHED",
"status": "AUTHORISED"
},
"route": "CREDORAX"
},
"paymentMethod": {
"card": {
"cardToken": "MT_TPN3a4X6QhmMmOGxHWE6ew",
"new": true,
"cardType": "MC_DEBIT",
"cardUsageType": "DEBIT",
"cardScheme": "VISA",
"maskedPan": "910400******5139",
"expiryDate": "0115",
"issuer": "PAY360_TEST_BANK",
"issuerCountry": "BUR",
"cardHolderName": "John Smith",
"cardNickname": "John",
"validDate": "1111"
},
"billingAddress": {
"line1": "Flat 1 ",
"line2": "Cauldron house",
"line3": "A Street",
"line4": "Twertonia",
"city": "Bath",
"region": "Somerset",
"postcode": "BA1 234",
"country": "United Kingdom",
"countryCode": "GBR"
},
"paymentClass": "CARD"
},
"customFields": {
"fieldState": [
{
"name": "measure_CV2_FAILURES",
"value": "0",
"transient": false
},
{
"name": "measure_NO_DATA_MATCH",
"value": "0",
"transient": false
},
{
"name": "measure_ADDRESS_MATCH_ONLY",
"value": "0",
"transient": false
},
{
"name": "measure_TOTAL_CARD_SPEND",
"value": "0",
"transient": false
}
]
},
"threeDSecure": {
"scheme": "MASTERCARD_SECURECODE",
"status": "AUTHENTICATED",
"enrolmentIndicator": "Y",
"enrolmentStatus": "ENROLLED",
"enrolmentDateTime": "2014-03-18T09:09:58.414Z",
"authenticationIndicator": "Y",
"authenticationStatus": "AUTHENTICATED",
"xid": "00000000012201301746",
"eci": "02",
"version": "1",
"protocolVersion": "1.0.2"
},
"customer": {
"id": "10736",
"merchantRef": "mer_cust_131241412"
},
"financialServices": {
"dateOfBirth": "19870818",
"surname": "Smith",
"accountNumber": "123ABC",
"postCode": "BS20"
},
"transaction": {
"transactionId": "12201301746",
"merchantRef": "mer_txn_1234556",
"status": "SUCCESS",
"type": "PAYMENT",
"amount": 1000,
"consumerSpend" 1000,
"currency": "GBP",
"transactionTime": "2014-03-18T09:11:26.005Z",
"receivedTime": "2014-03-18T09:11:26.005Z",
"channel": "WEB"
},
"outcome": {
"status": "SUCCESS",
"reasonCode": "S100",
"reasonMessage": "Authorised"
},
"link": [
{
"rel": "transaction",
"href": "https://api.mite.pay360.com/acceptor/rest/transactions/7010/12201301746"
}
]
}
Resume a 3DSecure v2 suspended payment
POST /acceptor/rest/transactions/{instId}/{transactionId}/resume
{}
HTTP/1.1 201
{
"processing": {
"authResponse": {
"acquirerName": "B\u0026S Card Services",
"gatewayReference": "111gbp76e2a6dad4daa2eFMeeee10z00",
"gatewayCode": "000.000.000",
"gatewayMessage": "Transaction succeeded",
"avsAddressCheck": "FULL_MATCH",
"avsPostcodeCheck": "FULL_MATCH",
"cv2Check": "MATCHED",
"status": "AUTHORISED"
},
"route": "PAYON"
},
"paymentMethod": {
"card": {
"cardToken": "MT_TPN3a4X6QhmMmOGxHWE6ew",
"new": true,
"cardType": "MC_DEBIT",
"cardUsageType": "DEBIT",
"cardScheme": "VISA",
"maskedPan": "910400******5139",
"expiryDate": "0115",
"issuer": "PAY360_TEST_BANK",
"issuerCountry": "BUR",
"cardHolderName": "John Smith",
"cardNickname": "John",
"validDate": "1111"
},
"billingAddress": {
"line1": "Flat 1 ",
"line2": "Cauldron house",
"line3": "A Street",
"line4": "Twertonia",
"city": "Bath",
"region": "Somerset",
"postcode": "BA1 234",
"country": "United Kingdom",
"countryCode": "GBR"
},
"paymentClass": "CARD"
},
"customFields": {
"fieldState": [
{
"name": "measure_CV2_FAILURES",
"value": "0",
"transient": false
},
{
"name": "measure_NO_DATA_MATCH",
"value": "0",
"transient": false
},
{
"name": "measure_ADDRESS_MATCH_ONLY",
"value": "0",
"transient": false
},
{
"name": "measure_TOTAL_CARD_SPEND",
"value": "0",
"transient": false
}
]
},
"threeDSecure": {
"scheme": "MASTERCARD_IDENTITY_CHECK",
"status": "AUTHENTICATED",
"eci": "02",
"version": 2,
"protocolVersion": "2.1.0",
"versionsAttempted": [
{
"version": 2,
"availability": "AVAILABLE",
}
],
"threeDSServerTransId": "3db341c2-b6d0-4b08-aef5-daa63b7368a0",
"dsTransactionId": "b61a4f20-b343-4e8c-9d47-6dae20b43332",
"acsTransactionId": "f6b6a2dd-23c3-443a-820c-01338fc696bd",
"challengeRequest": "NO_PREFERENCE",
"frictionless": false
},
"customer": {
"id": "10736",
"merchantRef": "mer_cust_131241412"
},
"financialServices": {
"dateOfBirth": "19870818",
"surname": "Smith",
"accountNumber": "123ABC",
"postCode": "BS20"
},
"transaction": {
"transactionId": "12201301746",
"merchantRef": "mer_txn_1234556",
"status": "SUCCESS",
"type": "PAYMENT",
"amount": 1000,
"consumerSpend" 1000,
"currency": "GBP",
"transactionTime": "2020-08-18T09:11:26.005Z",
"receivedTime": "2020-08-18T09:11:26.005Z",
"channel": "WEB"
},
"outcome": {
"status": "SUCCESS",
"reasonCode": "S100",
"reasonMessage": "Authorised"
},
"link": [
{
"rel": "transaction",
"href": "https://api.mite.pay360.com/acceptor/rest/transactions/7010/12201301746"
}
]
}
API Endpoint
request body:
| { | |
| threeDSecureResponse { | |
| pares | string Mandatory for 3DSv1 |
| } | |
| } | |
response:
| { | |
| clientRedirect { | Information about where to send your customer in the case of 3DS or a Callback. |
| frame | string Possible Values: CONTAINER, TOP The redirect type when the transaction is set to suspend and redirect to a new URL. |
| pareq | string Returned when the transaction is suspended for 3DS authorisation. |
| url | string Returned when theThe URL the Customer should be redirected to. |
| } | |
| fraudGuard { | Information about the Payment. |
| score | float The score assigned by FraudGuard. Refer to FraudGuard documentation for further details. |
| geoLocation { | |
| ipCountry { | |
| country | string The three-character ISO code representing the country of origin, determined by the IP address. |
| ipValues | string Possible Values: PROXY, SATELLITE, EUROPE, APAC Categorisation of the IP address used. |
| } | |
| ipCity | string The origin city of the transaction request, determined by the IP address. |
| ipRegion | string The origin state or province of the transaction request, determined by the IP address. |
| distanceFromIpToBilling | int The physical distance from the billing address to the location determined from the IP address. |
| } | |
| channelRisk { | |
| freeEmailProvider | boolean Whether or not the email address provided in the transaction request is hosted by a free provider. |
| openProxyRisk | float A rating of how likely it is that the transaction request originated from behind an open proxy. |
| } | |
| recentActivity { | |
| last24Hours { | |
| attemptsViaIp | int How many transaction requests have originated from this IP address in the last 24 hours. |
| attemptsOnCard | int How many transaction requests have used this card in the last 24 hours. |
| } | |
| } | |
| identityMorphing { | |
| againstAddress | int Measure of identity morphing against the address. |
| againstEmail | int Measure of identity morphing against the email address. |
| againstCard | int Measure of identity morphing against the card details. |
| againstIp | int Measure of identity morphing against the IP address. |
| } | |
| } | |
| transaction { | |
| transactionId | string Our ID for the transaction. |
| deferred | boolean Indicates if the Payment capture is deferred. |
| merchantRef | string Your reference for the transaction. |
| merchantDescription | string The description of the transaction provided in the request. |
| status | string Possible Values: SUCCESS, FAILED, PENDING, EXPIRED, CANCELLED, VOIDED The current state of the transaction. |
| type | string Possible Values: PAYMENT, PREAUTH, PAYOUT, REFUND, CAPTURE, CANCEL, REPEAT, CASH_ISSUE, CASH_PAYMENT Indicates the type of the transaction. |
| amount | float Indicates the requested amount of the transaction. |
| consumerSpend | float Indicates the actual amount of the transaction. This will be zero for any type of INITIALIZE transaction, deferred transactions, and rejected transactions. |
| currency | string Indicates the currency of the transaction. Use the 3 character ISO-4217 code. |
| transactionTime | string The date and time we processed the transaction in ISO-8601 format. |
| receivedTime | string The date and time we received the transaction in ISO-8601 format. |
| commerceType | string Possible Values: ECOM, MOTO, CNP The Commerce Type of the transaction. |
| channel | string Possible Values: WEB, MOBILE, SMS, RETAIL, MOTO, IVR, OTHER The Sales Channel of the transaction. |
| relatedTransaction { | This field is not applicable for Payments. In case of Refunds it indicates the transaction that was refunded. |
| transactionId | string Our ID for the transaction that was original. |
| merchantRef | string Your reference for the transaction that was original. |
| } | |
| } | |
| processing { | Information about the authorisation status of your transaction. |
| route | string The name of the processing engine your transaction was submitted to. |
| voidSuccessful | boolean Indicates if the transaction was voided by a Post Authorisation callback. |
| authResponse { | |
| statusCode | string The code for the status received from the authoriser, if applicable. |
| acquirerReference | string The reference received from the authoriser for your transaction, if applicable. |
| acquirerName | string Name of the authoriser, if applicable. |
| message | string The message received from the authoriser, if applicable. |
| authCode | string The code received from the authoriser, if applicable. |
| gatewayReference | string The reference received from the processing engine. |
| gatewaySettlement | string The date the processing engine will settle the transaction. in YYYY-MM-DD format. |
| gatewayCode | string The code for the status received from the processing engine. |
| gatewayMessage | string The message received from the processing engine. |
| avsAddressCheck | string Possible Values: NOT_CHECKED, FULL_MATCH, NOT_MATCHED, NOT_PROVIDED Results for the Address Verification checks, if applicable, if applicable. |
| avsPostcodeCheck | string Possible Values: NOT_CHECKED, FULL_MATCH, NOT_MATCHED, NOT_PROVIDED Results for the PostCode Verification checks, if applicable. |
| cv2Check | string Possible Values: NOT_CHECKED, MATCHED, NOT_MATCHED Results for the CV2 Verification checks, if applicable. |
| gatewayStatus | string The status received from the processing engine. |
| status | string Possible Values: AUTHORISED, DECLINED, REVERSED, REVERSE_FAILED, ERROR The status received from the authoriser, if applicable. |
| } | |
| } | |
| threeDSecure | Information about the 3D Secure status of your transaction. |
| version | string Possible Values: 1, 2 Major version of 3D Secure applied to this transaction. |
| protocolVersion | string Possible Values: 1.0.2, 2.1.0, 2.2.0 Full protocol version of 3D Secure applied to this transaction. |
| versionsAttempted [ { | string Possible Values: 1.0.2, 2.1.0, 2.2.0 Full protocol version of 3D Secure applied to this transaction. |
| version | integer Possible Values: 1,2 Major version of 3D Secure that was attempted. |
| availability | string Possible Values: INSUFFICIENT_DATA, ISSUER_NO_V2, ISSUER_NO_V1, ISSUER_NO_3DS, ERROR, AVAILABLE High-level indication of the actual availability of the given 3D Secure version and what happened during the attempt to use it; when a fall back occurs, this will indicate why. |
| } ] | |
| scheme | string The scheme that processed the transaction for 3DS. |
| eci | string The eCommerce indicator for the transaction. |
| status | string Possible Values: AUTHENTICATED, BYPASSED, FAILED, NOT_ENROLLED, ATTEMPTED, ENROLMENT_CHECK_FAILURE, INCOMPLETE, NOT_AVAILABLE, NOT_IMPLEMENTED The overall 3DS result for the transaction. |
| authenticationStatus | string Possible Values: AUTHENTICATED, ATTEMPTED, FAILED, ERROR The status of 3DS authentication check. 3DSv1 Only. |
| authenticationIndicator | string Possible Values: Y, A, N, U The indicator of the 3DS authentication status. 3DSv1 Only. |
| enrolmentDateTime | string The date and time the 3DS enrolment check was performed in ISO-8601 format. 3DSv1 Only. |
| xid | string The ID used during 3DS processing. 3DSv1 Only. |
| enrolmentIndicator | string Possible Values: Y, N, U The indicator of the 3DS enrolment status. 3DSv1 Only. |
| enrolmentStatus | string Possible Values: ENROLLED, NOT_ENROLLED, UNABLE_TO_AUTHENTICATE The status of the 3DS enrolment check. 3DSv1 Only. |
| threeDSServerTransId | string Pay360 3D Secure transaction ID. 3DSv2 Only. |
| dsTransactionId | string Directory Server transaction ID. 3DSv2 Only. |
| acsTransactionId | string Access Control Server (ACS) transaction ID. 3DSv2 Only. |
| challengeRequest | string Possible Values: NO_PREFERENCE, NO_CHALLENGE_REQUESTED, CHALLENGE_REQUESTED, CHALLENGE_MANDATED Indicates whether a challenge was ultimately requested or not; this reflects the final request made by Pay360 after taking into account any merchant preference and card scheme rules. 3DSv2 Only. |
| frictionless | boolean Whether the cardholder was authenticated without a challenge (frictionless flow). 3DSv2 Only. |
| } | |
| customer { | Information about the Customer. |
| id | string Our ID for the Customer. |
| merchantRef | string Your reference for the Customer. |
| } | |
| financialServices { | Information about the financial services. |
| dateOfBirth | string The Customer’s date of birth. |
| surname | string The Customer’s surname. |
| accountNumber | string The loan account number provided by the merchant, to the Customer. |
| postCode | string The postal code of the Customer’s billing address. |
| } | |
| outcome { | Information about the overal outcome of the request. |
| reasonMessage | string A message indicating the overall outcome of the request. This is where we’ll provide detailed reasons for any errors. |
| status | string Possible Values: SUCCESS, FAILED The overall outcome of the request. |
| reasonCode | string A code indicating the overall outcome of the request. Refer to Errors for more information. |
| } | |
| paymentMethod { | Information about the Payment Method used in the request. |
| paymentClass | string The classification of payment method used. Eg. Card, Cash, PayPal |
| registered | boolean Indicates that the customer choose to register this card payment method. This field will not be present for non-card payment methods. |
| isPrimary | boolean Indicates if this was Customer’s primary registered payment method. |
| card { | |
| issueNumber | string The issue number of the card used in the request. |
| cardToken | string The token for the card. |
| cardHolderName | string The Cardholder’s name. |
| issuer | string The Issuer of the card. |
| maskedPan | string The masked card number. eg. 123456******1234 |
| issuerCountry | string The country of the card Issuer. |
| expiryDate | string The expiry date of the card. Formatted as MMYY. |
| validDate | string The valid from date of the card. Formatted as MMYY. |
| cardType | string The type of card. Eg. MC_DEBIT, VISA_CREDIT, AMEX. |
| cardUsageType | string The usage type of card. Eg. DEBIT, CREDIT. |
| cardScheme | string The scheme of card. Eg. VISA, MASTERCARD, AMEX. |
| cardCategory | string The category of card. Eg. CREDIT, DEBIT, CORPORATE, BUSINESS. |
| cardNickname | string The name the Customer provided for their Card to allow easy selection where they registered multiple cards. |
| } | |
| billingAddress { | The billing address of the Customer. Will be used for AVS checks. |
| line1 | string Line 1 of the Customer’s billing address. |
| line2 | string Line 2 of the Customer’s billing address. |
| line3 | string Line 3 of the Customer’s billing address. |
| line4 | string Line 4 of the Customer’s billing address. |
| city | string City of the Customer’s billing address. |
| region | string Region of the Customer’s billing address. |
| postcode | string Post Code of the Customer’s billing address. |
| country | string Country name of the Customer’s billing address. |
| countryCode | string The 3 character ISO-3166-1 code for the Customer’s billing address country. |
| } | |
| } | |
| } | |
Hosted Endpoint
response:
| { | |
| sessionId | string Our ID for the hosted session. |
| redirectUrl | string The URL you should direct your customer to to start the hosted session. |
| status | string Possible Values: SUCCESS, FAILED Indicates the status of the session creation. |
| reasonCode | string Further information about the status of the session creation. |
| reasonMessage | string Further information about the status of the session creation. This is where we will provide detailed information about any errors. |
| } | |