Submit customer payments initiated online or over the phone using the Payment Request. Payments will authorise and capture the funds for settlement in one-step.
The request can additionally be processed with 3D Secure. Configuring your account for 3D Secure can be performed at boarding or at a later date.
APIHosted
API examples
Payment without customer (guest payment)
POST /acceptor/rest/transactions/{instId}/payment
{
"transaction": {
"currency": "GBP",
"amount": "25.00",
"merchantRef": "TXN-0001",
"description": "Sample Payment",
"commerceType": "ECOM"
},
"paymentMethod": {
"card": {
"pan": "9900000000000010",
"expiryDate": "1229",
"cv2": "123",
"cardHolderName": "John Smith"
},
"billingAddress": {
"line1": "1 Some Street",
"city": "Metropolis",
"postcode": "AA1 2BB",
"countryCode": "GBR"
}
}
}
HTTP/1.1 201 Created
{
"processing": {
"model": "MANAGE",
"authResponse": {
"statusCode": "00",
"acquirerName": "Barclays Merchant Services",
"message": "AUTH CODE:116283",
"authCode": "116283",
"gatewayReference": "ff67e3fed51e197db4bb1f30e8a20782",
"gatewayMessage": "AUTH CODE:116283",
"avsAddressCheck": "FULL_MATCH",
"avsPostcodeCheck": "FULL_MATCH",
"cv2Check": "MATCHED",
"status": "AUTHORISED"
},
"route": "CPE"
},
"paymentMethod": {
"registered": false,
"card": {
"cardFingerprint": "0hbdt0r/7ofTCqA5qKilqtHeeJg=",
"new": true,
"cardType": "MC_DEBIT",
"cardUsageType": "DEBIT",
"cardScheme": "MASTERCARD",
"cardCategory": "DEBIT",
"maskedPan": "990000******0010",
"expiryDate": "1229",
"issuer": "PAY360 TESTING",
"issuerCountry": "GBR",
"cardHolderName": "John Smith"
},
"billingAddress": {
"line1": "1 Some Street",
"city": "Metropolis",
"postcode": "AA1 2BB",
"country": "United Kingdom",
"countryCode": "GBR"
},
"paymentClass": "CARD",
"reuse": {
"storage": "NONE"
}
},
"customFields": {
"fieldState": []
},
"transaction": {
"transactionId": "10213520962",
"merchantRef": "TXN-0001",
"merchantDescription": "Sample Payment",
"status": "SUCCESS",
"stage": "COMPLETE",
"type": "PAYMENT",
"amount": 25,
"consumerSpend": 25,
"currency": "GBP",
"transactionTime": "2024-09-02T19:09:43.439+01:00",
"receivedTime": "2024-09-02T19:09:43.439+01:00",
"customerInitiated": true
},
"outcome": {
"status": "SUCCESS",
"reasonCode": "S100",
"reasonMessage": "Authorised"
},
"trace": "T8ily40k8gGYLujOCljwC7g",
"link": [
{
"href": "https://api.mite.pay360.com/acceptor/rest/transactions/5302522/10213520962",
"rel": "transaction"
}
]
}
Payment saving card for a new customer
POST /acceptor/rest/transactions/{instId}/payment
{
"transaction": {
"currency": "GBP",
"amount": "25.00",
"merchantRef": "TXN-0002",
"description": "Sample Payment",
"commerceType": "ECOM"
},
"customer": {
"merchantRef": "CUST-0001",
"displayName": "John Smith",
"email": "[email protected]",
"telephone": "+441234567890",
"ip": "185.161.165.20"
},
"paymentMethod": {
"card": {
"pan": "9902000000000018",
"expiryDate": "1229",
"cv2": "123",
"cardHolderName": "John Smith"
},
"billingAddress": {
"line1": "1 Some Street",
"city": "Metropolis",
"postcode": "AA1 2BB",
"countryCode": "GBR"
}
}
}
HTTP/1.1 201 Created
{
"processing": {
"model": "MANAGE",
"authResponse": {
"statusCode": "00",
"acquirerName": "Barclays Merchant Services",
"message": "AUTH CODE:634920",
"authCode": "634920",
"gatewayReference": "5f9ad54a83b5ee7a1b35b5302803c2b7",
"gatewayMessage": "AUTH CODE:634920",
"avsAddressCheck": "FULL_MATCH",
"avsPostcodeCheck": "FULL_MATCH",
"cv2Check": "MATCHED",
"status": "AUTHORISED"
},
"route": "CPE"
},
"paymentMethod": {
"registered": true,
"card": {
"cardToken": "MT_QXG4ltszTiyiz1nWbQydnA",
"cardFingerprint": "l313hfHapXJiLXyROD3X6P75k9E=",
"new": true,
"cardType": "VISA_DEBIT",
"cardUsageType": "DEBIT",
"cardScheme": "VISA",
"cardCategory": "DEBIT",
"maskedPan": "990200******0018",
"expiryDate": "1229",
"issuer": "PAY360 TESTING",
"issuerCountry": "GBR",
"cardHolderName": "John Smith"
},
"billingAddress": {
"line1": "1 Some Street",
"city": "Metropolis",
"postcode": "AA1 2BB",
"country": "United Kingdom",
"countryCode": "GBR"
},
"paymentClass": "CARD",
"reuse": {
"storage": "NEW",
"agreement": "ADHOC",
"receivedSchemeReference": "XWM3I9SBV3ORCO"
}
},
"customFields": {
"fieldState": []
},
"customer": {
"id": "2453687",
"merchantRef": "CUST-0001"
},
"transaction": {
"transactionId": "10213520965",
"merchantRef": "TXN-0002",
"merchantDescription": "Sample Payment",
"status": "SUCCESS",
"stage": "COMPLETE",
"type": "PAYMENT",
"amount": 25,
"consumerSpend": 25,
"currency": "GBP",
"transactionTime": "2024-09-02T19:22:36.422+01:00",
"receivedTime": "2024-09-02T19:22:36.422+01:00",
"customerInitiated": true
},
"outcome": {
"status": "SUCCESS",
"reasonCode": "S100",
"reasonMessage": "Authorised"
},
"trace": "TBxYU9RS-RyfnP52P9Yh6bw",
"link": [
{
"href": "https://api.mite.pay360.com/acceptor/rest/transactions/5302522/10213520965",
"rel": "transaction"
}
]
}
Payment using default card for an existing customer
POST /acceptor/rest/transactions/{instId}/payment
{
"transaction": {
"currency": "GBP",
"amount": "25.00",
"merchantRef": "TXN-0003",
"description": "Sample Payment",
"commerceType": "ECOM"
},
"customer": {
"merchantRef": "CUST-0001",
"ip": "185.161.165.20"
},
"paymentMethod": {
"fromCustomer": {
"cv2": "123"
}
}
}
HTTP/1.1 201 Created
{
"processing": {
"model": "MANAGE",
"authResponse": {
"statusCode": "00",
"acquirerName": "Barclays Merchant Services",
"message": "AUTH CODE:572009",
"authCode": "572009",
"gatewayReference": "a689a7919a629904ddd164209ba78894",
"gatewayMessage": "AUTH CODE:572009",
"avsAddressCheck": "FULL_MATCH",
"avsPostcodeCheck": "FULL_MATCH",
"cv2Check": "MATCHED",
"status": "AUTHORISED"
},
"route": "CPE"
},
"paymentMethod": {
"registered": true,
"card": {
"cardToken": "MT_QXG4ltszTiyiz1nWbQydnA",
"cardFingerprint": "l313hfHapXJiLXyROD3X6P75k9E=",
"new": false,
"cardType": "VISA_DEBIT",
"cardUsageType": "DEBIT",
"cardScheme": "VISA",
"cardCategory": "DEBIT",
"maskedPan": "990200******0018",
"expiryDate": "1229",
"issuer": "PAY360 TESTING",
"issuerCountry": "GBR",
"cardHolderName": "John Smith"
},
"billingAddress": {
"line1": "1 Some Street",
"city": "Metropolis",
"postcode": "AA1 2BB",
"country": "United Kingdom",
"countryCode": "GBR"
},
"paymentClass": "CARD",
"reuse": {
"storage": "EXISTING",
"agreement": "ADHOC",
"originalSchemeReference": "XWM3I9SBV3ORCO",
"receivedSchemeReference": "699VJDIILOHYP4"
}
},
"customFields": {
"fieldState": []
},
"customer": {
"id": "2453687",
"merchantRef": "CUST-0001"
},
"transaction": {
"transactionId": "10213520966",
"merchantRef": "TXN-0003",
"merchantDescription": "Sample Payment",
"status": "SUCCESS",
"stage": "COMPLETE",
"type": "PAYMENT",
"amount": 25,
"consumerSpend": 25,
"currency": "GBP",
"transactionTime": "2024-09-02T19:26:25.953+01:00",
"receivedTime": "2024-09-02T19:26:25.953+01:00",
"customerInitiated": true
},
"outcome": {
"status": "SUCCESS",
"reasonCode": "S100",
"reasonMessage": "Authorised"
},
"trace": "TPUoVKGedfrLUvFZCiTKB1Q",
"link": [
{
"href": "https://api.mite.pay360.com/acceptor/rest/transactions/5302522/10213520966",
"rel": "transaction"
}
]
}
API Endpoint
endpoint: /acceptor/rest/transactions/{instId}/payment
method: POST
summary: process Payment
parameters:
Name
Data Type
Description
request body:
| { | |
| browserInfo { | |
| userAgentHeader | string The Customer’s user agent. |
| } | |
| sessionId | string Your reference for the Customer’s session. |
| transaction { | Mandatory |
| currency | string Mandatory The currency of your Customer’s transaction. Use the 3 character ISO-4217 code. |
| amount | float Mandatory The amount of your Customer’s transaction. |
| commerceType | string Mandatory Possible Values: ECOM, MOTO, CA The commerce type for your Customer’s transaction. |
| channel | string Possible Values: WEB, MOBILE, SMS, RETAIL, MOTO, IVR, OTHER The sales channel for your Customer’s transaction. |
| merchantRef | string Your reference for the transaction. Max length: 255. It’s recommended that you keep this unique. |
| deferred | boolean Indicates if you want the Payment to be Authorised and Captured separately. |
| recurring | boolean Set this field if you want to start a recurring Continuous Authority relationship from this transaction. |
| instalment | boolean Set this field if you want to start an instalment Continuous Authority relationship from this transaction. |
| description | string The description of the transaction. Maximum length: 255. |
| continuousAuthorityAgreement { | Conditional The continuous authority agreement established with the cardholder. Required if you want to process a transaction initiating a recurring or instalment series using 3DSv2 |
| minFrequency | integer Mandatory Minimum number of days expected between payments in a recurring or instalment sequence. Must be >= 1. |
| expiry | string Mandatory Date (YYYY-MM-DD) at which recurring/instalment agreement expires, or at which it will need to be re-authenticated in order to continue. Must be in the future. |
| numberOfInstalments | integer Conditional Total number of payments in an instalment sequence – including this one, if starting with a payment. Required only for instalments; must be >= 2. |
| } | |
| } | |
| locale | string The ISO-639-1 code for your Customer’s locale. |
| customer { | |
| id | string Our ID for the Customer where they are already registered with us. |
| update | boolean Indicates if you want to update the Customer’s details with the transaction. |
| string Email address for the Customer. |
|
| merchantRef | string Conditional Your reference for the Customer. Not required if registered is set to false, mandatory otherwise. |
| dob | string Date of birth for the Customer. |
| billingAddress { | The address of the Customer. |
| line1 | string Line 1 of the Customer’s address. |
| line2 | string Line 2 of the Customer’s address. |
| line3 | string Line 3 of the Customer’s address. |
| line4 | string Line 4 of the Customer’s address. |
| city | string City of the Customer’s address. |
| region | string Region of the Customer’s address. |
| postcode | string Post Code of the Customer’s address. |
| countryCode | string The 3 character ISO-3166-1 code for the Customer’s address country |
| } | |
| displayName | string Conditional The Customer’s name. Not required if registered is set to false, mandatory otherwise. |
| telephone | string Telephone number for the customer. For best results, use international format, e.g. “+441234567890”. |
| ip | string The Customer’s IP address. |
| registered | boolean Indicates if we should register your customer; false if you do not wish to register your customer, otherwise set to true, default value is true. |
| } | |
| financialServices { |
Supplementary data for Financial Services payments, including loan repayments and other credit-related activities. UK- and Europe-based merchants with merchant category code (MCC) 6012, and some merchants coded MCC 6051 or MCC 7299, are required to provide this information about the primary recipient, who may be different from the customer making payment. Consult your acquirer if you are not sure whether you should submit this. Cannot be submitted in conjunction with accountFunding. |
| dateOfBirth | string Date of birth of the recipient, in YYYYMMDD format. For example, for Jan 2nd, 1980, this would be “19800102”. |
| surname | string Surname/family name of the recipient; up to six characters, excluding numbers or special characters. If the name is longer than six characters, then provide the first six. For example, for “Smith”, this would be “Smith”; for “Williams”, this would be “Willia”. |
| accountNumber | string Account number used to identify the recipient or loan. If this is a PAN, then provide the first six and last four digits of the PAN. Otherwise, provide up to ten characters of the account number. |
| postCode | string First part of the recipient’s postal code; up to six characters. For example, if the postal code is “LE11 3QF”, this would be “LE11”. |
| } | |
| accountFunding { |
Supplementary data for Account Funding Transactions (AFT), e.g. money transfers. You should provide this if advised by your acquirer. Cannot be submitted in conjunction with financialServices. |
| recipient { | Details about the funding recipient |
| givenName | string Recipient’s given name |
| surname | string Recipient’s surname/family name |
| address | string Recipient’s address (house/building name and number, street/road name, etc.) |
| city | string Recipient city |
| state | string Only for recipients based in the US or Canada Recipient state/province code (2-3 characters), e.g. “CA”, “DE”, “MD”, “TN” et al. in the US; “AB”, “ON”, “QC”, “SK” et al. in Canada |
| countryCode | string Recipient country code (ISO-3166-alpha-3), e.g. “CAN”, “GBR”, “USA” et al. |
| } | |
| } | |
| transactionOptions { | |
| do3DSecure | boolean Indicates if the transaction should be processed with 3DS. This will override account configuration for 3DS. |
| sendEmailReceipt | boolean If true, an email receipt will be sent for this transaction. If false, no receipt will be sent. If not present, your account configuration determines if an email is sent. |
| provisionNetworkToken | boolean Set false to opt out of provisioning a token Omit or set true to provision according to account configuration. |
| } | |
| paymentMethod { | Mandatory |
| fromCustomer { | Mandatory Use if you want to use your Customer’s default card. This section is mandatory if you are not providing a token or full card details. |
| cv2 | string The Customer’s Card Security Code (CSC, CV2, CVV). |
| } | |
| registered | boolean Indicates if the supplied card payment method should be registered. If no value is supplied true is assumed. This field will not be accepted for non-card payment methods. |
| card { | Mandatory Use if you want to provide your Customer’s card details. This section is mandatory if you are not providing a token (merchant or CardLock) or details of the Customer’s default card. |
| pan | string Mandatory The card number. |
| cv2 | |