Created
November 19, 2020 19:35
-
-
Save Shmarkus/8d7dac1613275c9f2f48c34ff3a5f732 to your computer and use it in GitHub Desktop.
EveryPay OpenAPI spec (https://every-pay.com/downloads/EveryPay-APIv3-Integration-Documentation.pdf)
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| swagger: '2.0' | |
| info: | |
| description: | | |
| EveryPay API documentation. | |
| # Test Cards | |
| | Card type | Card number | Expiration date | CVC code | Cardholder name | | |
| |------------|------------------|-----------------|----------|-----------------| | |
| | Mastercard | 5204740000001002 | 12/25 | 100 | (any name) | |
| | Visa | 4012001037141112 | 12/27 | 212 | (any name) | |
| | Mastercard | 2223000010021381 | 12/19 | 656 | (any name) | |
| The 3DS authentication simulator (Poseidon bank/Swedbank) username and password is **secret** | |
| version: 0.0.1 | |
| title: EveryPay API | |
| host: igw-demo.every-pay.com | |
| basePath: /api/v3 | |
| schemes: | |
| - https | |
| tags: | |
| - name: Payments | |
| description: Payment services | |
| - name: Management | |
| description: Management services | |
| - name: Other | |
| description: Other services | |
| securityDefinitions: | |
| basicAuth: | |
| type: basic | |
| security: | |
| - basicAuth: [] | |
| paths: | |
| /payments/{payment_reference}: | |
| get: | |
| tags: | |
| - Other | |
| summary: Get current payment state | |
| description: | | |
| Returns the current state of the payment (similar response to payment initiation, with statuses updated to reflect changes). | |
| operationId: paymentReference | |
| produces: | |
| - 'application/json' | |
| consumes: | |
| - 'application/json' | |
| parameters: | |
| - in: path | |
| required: true | |
| name: payment_reference | |
| description: Reference ID of the payment. | |
| type: string | |
| - in: query | |
| name: api_username | |
| description: The api_username of the Merchant sending the request. Must match with username in Authorization HTTP header. | |
| type: string | |
| required: true | |
| - in: query | |
| name: detailed | |
| type: boolean | |
| description: Boolean to indicate that payment result should return fraudcheck details | |
| required: false | |
| responses: | |
| '200': | |
| description: Standard response for successful queries. | |
| schema: | |
| $ref: '#/definitions/PaymentReferenceResponse' | |
| '400': | |
| description: Returned if HTTP operation was not understood or was incorrectly formatted. | |
| '401': | |
| description: Returned if processing the request is refused because of failed authentication, nonce or timestamp. | |
| '403': | |
| description: Returned if processing the request is refused. | |
| '422': | |
| description: Returned if processing the request was not successful for any reason, including processing errors such as validation, fraud check or issuer declines. | |
| '500': | |
| description: Returned if the request cannot be processed because of the technical errors in the server. | |
| /processing_accounts/{account_name}: | |
| get: | |
| tags: | |
| - Other | |
| summary: Get details of the Processing Account | |
| description: | | |
| Returns details of the Processing Account, most importantly the available Payment Methods list. | |
| operationId: getProcessingAccount | |
| produces: | |
| - 'application/json' | |
| consumes: | |
| - 'application/json' | |
| parameters: | |
| - in: path | |
| required: true | |
| name: account_name | |
| type: string | |
| - in: query | |
| name: api_username | |
| type: string | |
| required: true | |
| responses: | |
| '200': | |
| description: Standard response for successful queries. | |
| schema: | |
| $ref: '#/definitions/ProcessingAccountsResponse' | |
| '400': | |
| description: Returned if HTTP operation was not understood or was incorrectly formatted. | |
| '401': | |
| description: Returned if processing the request is refused because of failed authentication, nonce or timestamp. | |
| '403': | |
| description: Returned if processing the request is refused. | |
| '422': | |
| description: Returned if processing the request was not successful for any reason, including processing errors such as validation, fraud check or issuer declines. | |
| '500': | |
| description: Returned if the request cannot be processed because of the technical errors in the server. | |
| /payments/recallback: | |
| get: | |
| deprecated: true | |
| tags: | |
| - Other | |
| summary: Resend callbacks | |
| description: | | |
| # to be released | |
| Can be used to ask Payment Gateway to send callbacks again for payments within a date range (less than 1 month). This can be used in case Merchant’s server has had outages or for other reasons missed some callbacks. | |
| operationId: resendCallbacks | |
| produces: | |
| - 'application/json' | |
| consumes: | |
| - 'application/json' | |
| responses: | |
| '200': | |
| description: Standard response for successful queries. | |
| '400': | |
| description: Returned if HTTP operation was not understood or was incorrectly formatted. | |
| '401': | |
| description: Returned if processing the request is refused because of failed authentication, nonce or timestamp. | |
| '403': | |
| description: Returned if processing the request is refused. | |
| '422': | |
| description: Returned if processing the request was not successful for any reason, including processing errors such as validation, fraud check or issuer declines. | |
| '500': | |
| description: Returned if the request cannot be processed because of the technical errors in the server. | |
| /shops: | |
| get: | |
| tags: | |
| - Other | |
| summary: Return a list of shops | |
| description: | | |
| Return a list of shops with primary configuration parameters for the shops. | |
| operationId: getShops | |
| parameters: | |
| - in: query | |
| name: api_username | |
| type: string | |
| required: true | |
| produces: | |
| - 'application/json' | |
| consumes: | |
| - 'application/json' | |
| responses: | |
| '200': | |
| description: Standard response for successful queries. | |
| schema: | |
| $ref: '#/definitions/ShopsResponse' | |
| '400': | |
| description: Returned if HTTP operation was not understood or was incorrectly formatted. | |
| '401': | |
| description: Returned if processing the request is refused because of failed authentication, nonce or timestamp. | |
| '403': | |
| description: Returned if processing the request is refused. | |
| '422': | |
| description: Returned if processing the request was not successful for any reason, including processing errors such as validation, fraud check or issuer declines. | |
| '500': | |
| description: Returned if the request cannot be processed because of the technical errors in the server. | |
| /shops/{id}: | |
| get: | |
| tags: | |
| - Other | |
| summary: Get shop details | |
| description: | | |
| Return info about a specific shop, including configured processing accounts | |
| operationId: getShop | |
| parameters: | |
| - in: path | |
| name: id | |
| type: number | |
| required: true | |
| - in: query | |
| name: api_username | |
| type: string | |
| required: true | |
| produces: | |
| - 'application/json' | |
| consumes: | |
| - 'application/json' | |
| responses: | |
| '200': | |
| description: Standard response for successful queries. | |
| schema: | |
| $ref: '#/definitions/ShopResponse' | |
| '400': | |
| description: Returned if HTTP operation was not understood or was incorrectly formatted. | |
| '401': | |
| description: Returned if processing the request is refused because of failed authentication, nonce or timestamp. | |
| '403': | |
| description: Returned if processing the request is refused. | |
| '422': | |
| description: Returned if processing the request was not successful for any reason, including processing errors such as validation, fraud check or issuer declines. | |
| '500': | |
| description: Returned if the request cannot be processed because of the technical errors in the server. | |
| /payments/void: | |
| get: | |
| tags: | |
| - Management | |
| summary: Reverse an authorized payment | |
| description: | | |
| Void transaction reverses an authorised payment that has not | |
| been set to be captured. This is only used for card transactions. | |
| operationId: voidPayment | |
| produces: | |
| - 'application/json' | |
| consumes: | |
| - 'application/json' | |
| responses: | |
| '200': | |
| description: Standard response for successful queries. | |
| '400': | |
| description: Returned if HTTP operation was not understood or was incorrectly formatted. | |
| '401': | |
| description: Returned if processing the request is refused because of failed authentication, nonce or timestamp. | |
| '403': | |
| description: Returned if processing the request is refused. | |
| '422': | |
| description: Returned if processing the request was not successful for any reason, including processing errors such as validation, fraud check or issuer declines. | |
| '500': | |
| description: Returned if the request cannot be processed because of the technical errors in the server. | |
| /payments/refund: | |
| get: | |
| tags: | |
| - Management | |
| summary: Refund payment | |
| description: | | |
| Refunding a settled payment will return the funds to the | |
| customer’s bank card. Payment can be refunded in full or partial amount. This is only | |
| used for card transactions. | |
| operationId: refundPayment | |
| produces: | |
| - 'application/json' | |
| consumes: | |
| - 'application/json' | |
| responses: | |
| '200': | |
| description: Standard response for successful queries. | |
| '400': | |
| description: Returned if HTTP operation was not understood or was incorrectly formatted. | |
| '401': | |
| description: Returned if processing the request is refused because of failed authentication, nonce or timestamp. | |
| '403': | |
| description: Returned if processing the request is refused. | |
| '422': | |
| description: Returned if processing the request was not successful for any reason, including processing errors such as validation, fraud check or issuer declines. | |
| '500': | |
| description: Returned if the request cannot be processed because of the technical errors in the server. | |
| /mobile_payments/card_details: | |
| get: | |
| tags: | |
| - Management | |
| summary: Set card details | |
| description: | | |
| It can be used by SDKs to set card details | |
| operationId: cardDetails | |
| produces: | |
| - 'application/json' | |
| consumes: | |
| - 'application/json' | |
| responses: | |
| '200': | |
| description: Standard response for successful queries. | |
| '400': | |
| description: Returned if HTTP operation was not understood or was incorrectly formatted. | |
| '401': | |
| description: Returned if processing the request is refused because of failed authentication, nonce or timestamp. | |
| '403': | |
| description: Returned if processing the request is refused. | |
| '422': | |
| description: Returned if processing the request was not successful for any reason, including processing errors such as validation, fraud check or issuer declines. | |
| '500': | |
| description: Returned if the request cannot be processed because of the technical errors in the server. | |
| /payments/capture: | |
| get: | |
| tags: | |
| - Management | |
| summary: Capture authorised payment | |
| description: | | |
| Capturing an authorised payment will complete (finalise) | |
| the payment. This is only used for card transactions. | |
| operationId: capture | |
| produces: | |
| - 'application/json' | |
| consumes: | |
| - 'application/json' | |
| responses: | |
| '200': | |
| description: Standard response for successful queries. | |
| '400': | |
| description: Returned if HTTP operation was not understood or was incorrectly formatted. | |
| '401': | |
| description: Returned if processing the request is refused because of failed authentication, nonce or timestamp. | |
| '403': | |
| description: Returned if processing the request is refused. | |
| '422': | |
| description: Returned if processing the request was not successful for any reason, including processing errors such as validation, fraud check or issuer declines. | |
| '500': | |
| description: Returned if the request cannot be processed because of the technical errors in the server. | |
| /payments/oneoff: | |
| post: | |
| tags: | |
| - Payments | |
| summary: One-off Payment | |
| description: | | |
| this endpoint can be used for the following use cases | |
| * For regular one-off payment; when the value of the request_token parameter | |
| is false, card details will not be stored and regular one-off payment is made. | |
| Token_agreement is not specified for this payment. | |
| * To save card details for MIT and CIT; when request_token = ‘true’ and | |
| token_agreement is specified as ‘unscheduled’, card details are saved | |
| and payment is made. The stored card can be used in future MIT/CIT | |
| payments. | |
| * To save card details for recurring payments and subscriptions; when | |
| request_token = ‘true’ and token_agreement is specified as ‘recurring’, | |
| card details are saved and payment is made. | |
| * To save card details without any purchase; when the amount is set as 0, | |
| request_token = ‘true’ and token_agreement is selected as either | |
| ‘unscheduled’ or ‘recurring’ card details are saved for future | |
| MIT/CIT or subscription without any purchase. | |
| **Note** Token_agreement must be specified when request_token=’true’ | |
| operationId: oneoffPayment | |
| parameters: | |
| - in: body | |
| name: oneOffRequest | |
| required: true | |
| schema: | |
| $ref: '#/definitions/OneOffRequest' | |
| produces: | |
| - 'application/json' | |
| consumes: | |
| - 'application/json' | |
| responses: | |
| '200': | |
| description: Standard response for successful queries. | |
| schema: | |
| $ref: '#/definitions/OneOffResponse' | |
| '400': | |
| description: Returned if HTTP operation was not understood or was incorrectly formatted. | |
| '401': | |
| description: Returned if processing the request is refused because of failed authentication, nonce or timestamp. | |
| '403': | |
| description: Returned if processing the request is refused. | |
| '422': | |
| description: Returned if processing the request was not successful for any reason, including processing errors such as validation, fraud check or issuer declines. | |
| '500': | |
| description: Returned if the request cannot be processed because of the technical errors in the server. | |
| /payments/mit: | |
| get: | |
| tags: | |
| - Payments | |
| summary: Merchant Initiated Transaction | |
| description: | | |
| Merchant Initiated Transaction payment, the token agreement | |
| can be ‘unscheduled’ or ‘recurring’, the response is always finalised | |
| payment details (either successful or failed). This is only used for card transactions. | |
| operationId: mitPayment | |
| produces: | |
| - 'application/json' | |
| consumes: | |
| - 'application/json' | |
| responses: | |
| '200': | |
| description: Standard response for successful queries. | |
| '400': | |
| description: Returned if HTTP operation was not understood or was incorrectly formatted. | |
| '401': | |
| description: Returned if processing the request is refused because of failed authentication, nonce or timestamp. | |
| '403': | |
| description: Returned if processing the request is refused. | |
| '422': | |
| description: Returned if processing the request was not successful for any reason, including processing errors such as validation, fraud check or issuer declines. | |
| '500': | |
| description: Returned if the request cannot be processed because of the technical errors in the server. | |
| /payments/cit: | |
| get: | |
| tags: | |
| - Payments | |
| summary: Customer Initiated Transaction | |
| description: | | |
| Customer Initiated Transaction payment, the token agreement | |
| can only be ‘unscheduled’ and the response could be finalised payment details | |
| or contains ‘payment_link’ depending on the 3DS authentication requirements. | |
| This is only used for card transactions. | |
| operationId: citPayment | |
| produces: | |
| - 'application/json' | |
| consumes: | |
| - 'application/json' | |
| responses: | |
| '200': | |
| description: Standard response for successful queries. | |
| '400': | |
| description: Returned if HTTP operation was not understood or was incorrectly formatted. | |
| '401': | |
| description: Returned if processing the request is refused because of failed authentication, nonce or timestamp. | |
| '403': | |
| description: Returned if processing the request is refused. | |
| '422': | |
| description: Returned if processing the request was not successful for any reason, including processing errors such as validation, fraud check or issuer declines. | |
| '500': | |
| description: Returned if the request cannot be processed because of the technical errors in the server. | |
| definitions: | |
| TokenAgreementEnum: | |
| description: It must be sent when request_token=true. It is the type of the agreement. See the above Payment Types. It is a conditional parameter. | |
| type: string | |
| enum: | |
| - unscheduled | |
| - recurring | |
| PreferredCountryEnum: | |
| description: Default country for a payment selection page. When the payment selection page is opened, the preferred country’s alternative payment methods will be listed first. | |
| type: string | |
| enum: | |
| - EE | |
| - LT | |
| - LV | |
| LocaleEnum: | |
| type: string | |
| description: A locale that should be used as the default for payment UI. Customers can change it via menu. User’s previous preference overrides the locale requested by the merchant. | |
| enum: | |
| - en | |
| - et | |
| - fi | |
| - de | |
| - lv | |
| - lt | |
| - ru | |
| - es | |
| - sv | |
| - da | |
| - pl | |
| - it | |
| - fr | |
| - nl | |
| - pt | |
| - no | |
| IntegrationDetails: | |
| type: object | |
| properties: | |
| software: | |
| type: string | |
| description: The name of the software. | |
| version: | |
| type: string | |
| description: The version number of the integration software. | |
| integration: | |
| type: string | |
| description: Type of integration. (Plugin name or ‘custom’). | |
| PaymentMethods: | |
| type: object | |
| properties: | |
| source: | |
| type: string | |
| display_name: | |
| type: string | |
| logo_url: | |
| type: string | |
| payment_link: | |
| type: string | |
| OneOffRequest: | |
| type: object | |
| properties: | |
| api_username: | |
| type: string | |
| description: api_username of the Merchant sending the request. Must match with username in the Authorization HTTP header. | |
| account_name: | |
| type: string | |
| description: Processing account used for the payment. Most importantly, this will determine available payment methods and currency of the payment. | |
| amount: | |
| type: number | |
| description: Transaction amount, use decimal number with 2 digit precision, e.g. 10.55. The currency is taken from the specified processing account. Can be also set as 0 for card verification (saving card for further token payments). | |
| customer_url: | |
| type: string | |
| description: URL where the Customer should be redirected after completing the payment. payment_reference and order_reference parameters are added when a customer is redirected to customer_url. Customer URL has to be a fully qualified domain name, it is not possible to use an IP address or localhost. | |
| token_agreement: | |
| $ref: '#/definitions/TokenAgreementEnum' | |
| mobile_payment: | |
| type: boolean | |
| default: false | |
| description: Payment is initiated via mobile apps like SDK | |
| order_reference: | |
| type: string | |
| maxLength: 255 | |
| description: Merchant’s order reference. Uniqueness requirements can be configured in Portal. | |
| nonce: | |
| type: string | |
| description: Unique request (see below for details). | |
| timestamp: | |
| type: string | |
| format: date-time | |
| description: Request timestamp | |
| email: | |
| type: string | |
| format: email | |
| description: Customer’s email. Used for Fraud Prevention. | |
| customer_ip: | |
| type: string | |
| description: Customer’s IP address. Used for Fraud Prevention. Do not set this to some fixed value, e.g Merchant’s server, as this will start generating false positives in Fraud Check. | |
| preferred_country: | |
| $ref: '#/definitions/PreferredCountryEnum' | |
| billing_city: | |
| type: string | |
| description: Cardholder Billing address city. | |
| billing_country: | |
| type: string | |
| description: Cardholder Billing address country in ISO alpha-2 format. | |
| billing_line1: | |
| type: string | |
| description: Cardholder Billing address line 1. | |
| billing_line2: | |
| type: string | |
| description: Cardholder Billing address line 2. | |
| billing_line3: | |
| type: string | |
| description: Cardholder Billing address line 3. | |
| billing_postcode: | |
| type: string | |
| description: Cardholder Billing address postal code. | |
| billing_state: | |
| type: string | |
| description: Cardholder Billing address state in ISO 3166-2 format. | |
| shipping_city: | |
| type: string | |
| description: Cardholder shipping address city. It will be sent if available. | |
| shipping_country: | |
| type: string | |
| description: Cardholder shipping address country. It will be sent if available in ISO alpha-2 format. | |
| shipping_line1: | |
| type: string | |
| description: Cardholder shipping address line 1. It will be sent if available. | |
| shipping_line2: | |
| type: string | |
| description: Cardholder shipping address line 2. It will be sent if available. | |
| shipping_line3: | |
| type: string | |
| description: Cardholder shipping address line 3. It will be sent if available. | |
| shipping_code: | |
| type: string | |
| description: Cardholder shipping address postal code. It will be sent if available. | |
| shipping_state: | |
| type: string | |
| description: Cardholder shipping address state. It will be sent if available. | |
| locale: | |
| $ref: '#/definitions/LocaleEnum' | |
| request_token: | |
| type: boolean | |
| description: Boolean to indicate that payment should return a token in the response - for future token payment usage | |
| token_consent_agreed: | |
| type: boolean | |
| description: Boolean to indicate that merchant has token consent in Terms and Conditions to avoid the save card details checkbox in card details form timestamp A timestamp of request’s creation time (see below for details). | |
| skin_name: | |
| type: string | |
| description: The name of a skin configured in Portal – used to change the look and feel of the payment UI. (to be released). | |
| integration_details: | |
| type: string | |
| description: Details of integration. Following fields are subfields of this. | |
| integration_details.: | |
| $ref: '#/definitions/IntegrationDetails' | |
| example: | |
| api_username: "abc12345" | |
| account_name: "EUR3D1" | |
| amount: 10.00 | |
| order_reference: "912987" | |
| token_agreement: "unscheduled" | |
| nonce: "a9b7f7e794367c2c85d73154a01b9902" | |
| timestamp: "2019-06-05T13:14:15+03:00" | |
| email: "user@example.com" | |
| customer_ip: "1.2.3.4" | |
| customer_url: "https://shop.example.com/cart" | |
| preferred_country: "EE" | |
| billing_city: "Tartu" | |
| billing_country: "EE" | |
| billing_line1: "Main street 1" | |
| billing_line2: "Building 3" | |
| billing_line3: "Room 11" | |
| billing_postcode: "51009" | |
| billing_state: "EE" | |
| locale: "en" | |
| request_token: true | |
| skin_name: "shop1" | |
| integration_details: | |
| software: "magento" | |
| version: "1.6.4" | |
| integration: "plugin" | |
| OneOffResponse: | |
| type: object | |
| properties: | |
| api_username: | |
| type: string | |
| description: api_username of the Merchant sending the request. Must match with username in the Authorization HTTP header. | |
| account_name: | |
| type: string | |
| description: Processing account used for the payment. Most importantly, this will determine available payment methods and currency of the payment. | |
| initial_amount: | |
| type: number | |
| standing_amount: | |
| type: number | |
| order_reference: | |
| type: string | |
| email: | |
| type: string | |
| customer_ip: | |
| type: string | |
| customer_url: | |
| type: string | |
| payment_created_at: | |
| type: string | |
| format: date-time | |
| payment_reference: | |
| type: string | |
| payment_link: | |
| type: string | |
| payment_state: | |
| type: string | |
| payment_methods: | |
| type: array | |
| items: | |
| $ref: '#/definitions/PaymentMethods' | |
| example: | |
| api_username: "abc12345" | |
| account_name: "EUR3D1" | |
| initial_amount: 10.00 | |
| standing_amount: 10.00 | |
| order_reference: "feiwhp28qy8ks7i12i63" | |
| email: "user@example.com" | |
| customer_ip: "1.2.3.4" | |
| customer_url: "www.abc.com/callback" | |
| payment_created_at: "2019-06-05T13:14:15+03:00" | |
| payment_reference: "db98561ec7a380d2e0872a34ffccdd0c4d2f2fd237b6d0ac22f88f52a" | |
| payment_link: "https://igw-demo.every-pay.com/lp/aedf32/ed4dod" | |
| payment_state: "initial" | |
| payment_methods: | |
| - source: "card" | |
| display_name: "VISA/Mastercard" | |
| logo_url: "https://igw-demo.every-pay.com/assets/card_logo.png" | |
| payment_link: "https://igw-demo.every-pay.com/lp/aedf32/ed4dod?method_source=card" | |
| - source: "ob_mybank_ee" | |
| display_name: "MyBank Eesti" | |
| country_code: "EE" | |
| logo_url: "https://igw-demo.every-pay.com/assets/mybank_logo.png" | |
| payment_link: "https://igw-demo.every-pay.com/lp/aedf32/ed4dod?method_source=ob_mybank_ee" | |
| ShopsResponse: | |
| type: object | |
| properties: | |
| api_username: | |
| type: string | |
| description: api_username of the Merchant sending the request. Must match with username in the Authorization HTTP header. | |
| shops: | |
| type: array | |
| items: | |
| $ref: '#/definitions/Shop' | |
| example: | |
| "api_username": "abc12345" | |
| "shops": | |
| - "id": "1" | |
| "url": "https://electronicshop.com/" | |
| "descriptor": "Eesti Electronic Shop" | |
| "mcc": "1234" | |
| - "id": "2" | |
| "url": "https://myshoes.com/" | |
| "descriptor": "My Shoes AS" | |
| "mcc": "1235" | |
| - "id": "3" | |
| "url": "https://rentacar.com/" | |
| "descriptor": "My Car Rental" | |
| "mcc": "2222" | |
| Shop: | |
| type: object | |
| properties: | |
| id: | |
| type: integer | |
| format: int64 | |
| description: Unique ID for the shop. | |
| url: | |
| type: string | |
| description: Web address of the shop | |
| descriptor: | |
| type: string | |
| description: Descriptor of the shop. | |
| mcc: | |
| type: string | |
| description: Merchant category code of the shop. | |
| ProcessingAccounts: | |
| type: object | |
| properties: | |
| account_name: | |
| type: string | |
| description: Processing Account name that was used to process the transaction. | |
| pre_authorisation: | |
| type: boolean | |
| description: Type of authorization. Pre or Final Authorization. False means it is not pre_authorisation. | |
| currency: | |
| type: string | |
| description: Currency of processing account. | |
| support_3ds: | |
| type: boolean | |
| description: It shows if the processing account supports 3ds or not. | |
| capture_delay_days: | |
| type: string | |
| description: It shows the delay days for automatic capture of the transaction | |
| bav_required: | |
| type: boolean | |
| description: It shows if bank account verification is necessary or not. | |
| example: | |
| account_name: "EUR3D1" | |
| pre_authorisation: true | |
| currency: "EUR" | |
| support_3ds: true | |
| capture_delay_days: "0" | |
| bav_required: false | |
| ShopResponse: | |
| type: object | |
| properties: | |
| api_username: | |
| type: string | |
| description: api_username of the Merchant sending the request. Must match with username in the Authorization HTTP header. | |
| id: | |
| type: integer | |
| format: int64 | |
| description: Unique ID for the shop. | |
| url: | |
| type: string | |
| description: Web address of the shop | |
| descriptor: | |
| type: string | |
| description: Descriptor of the shop. | |
| mcc: | |
| type: string | |
| description: Merchant category code of the shop. | |
| processing_accounts: | |
| type: array | |
| items: | |
| $ref: '#/definitions/ProcessingAccounts' | |
| example: | |
| api_username: "abc12345" | |
| id: 8 | |
| url: "https://electronicshop.com/" | |
| descriptor: "Eesti Electronic Shop" | |
| mcc: "1234" | |
| processing_accounts: | |
| - account_name: "EUR3D1" | |
| pre_authorisation: "true" | |
| currency: "EUR" | |
| support_3ds: "true" | |
| capture_delay_days: "0" | |
| bav_required: "false" | |
| - account_name: "EUR1" | |
| pre_authorisation: "false" | |
| currency: "EUR" | |
| support_3ds: "false" | |
| capture_delay_days: "3" | |
| bav_required: "false" | |
| - account_name: "USD3D1" | |
| pre_authorisation: "false" | |
| currency: "USD" | |
| support_3ds: "true" | |
| capture_delay_days: "0" | |
| bav_required: "false" | |
| - account_name: "AUD1" | |
| pre_authorisation: "false" | |
| currency: "AUD" | |
| support_3ds: "false" | |
| capture_delay_days: "0" | |
| bav_required: "false" | |
| ProcessingAccountsResponse: | |
| type: object | |
| properties: | |
| api_username: | |
| type: string | |
| description: The api_username of the Merchant sending the request. Must match with username in Authorization HTTP header. | |
| account_name: | |
| type: string | |
| description: Processing Account name that was used to process the transaction. | |
| pre_auth: | |
| type: string | |
| description: Type of authorization. Pre or Final Authorization. | |
| currency: | |
| type: string | |
| description: Currency of processing account. | |
| support_3ds: | |
| type: string | |
| description: It shows if the processing account supports 3ds or not. | |
| capture_delay_days: | |
| type: integer | |
| format: int64 | |
| description: It shows the delay days for automatic capture of the transaction. | |
| bav_required: | |
| type: boolean | |
| description: It shows if bank account verification is necessary or not. | |
| payment_methods: | |
| type: array | |
| items: | |
| $ref: '#/definitions/PaymentMethod' | |
| description: List of available payment methods for the processing account. | |
| example: | |
| api_username: "abc12345" | |
| account_name: "EUR3D2" | |
| pre_auth: "final" | |
| currency: "EUR" | |
| support_3ds: "true" | |
| capture_delay_days: "0" | |
| bav_required: "false" | |
| payment_methods: | |
| - source: "card" | |
| display_name: "VISA/Mastercard" | |
| logo_url: "https://igw-demo.every-pay.com/assets/card_logo.png" | |
| card_acceptor_id: "10234957 100" | |
| terminal_id: "EVR20797" | |
| - source: "ob_mybank_ee" | |
| display_name: "MyBank Eesti" | |
| country_code: "EE" | |
| logo_url: "https://igw-demo.every-pay.com/assets/mybank_logo.png" | |
| PaymentMethod: | |
| type: object | |
| properties: | |
| source: | |
| type: string | |
| description: Source of payment method. See Payment Methods above for a list of possible values. Example card | |
| display_name: | |
| type: string | |
| description: Display name for the Payment Method. Ex Card Payment. | |
| logo_url: | |
| type: string | |
| description: URL to fetch logo for this Payment Method. | |
| country_code: | |
| type: string | |
| description: Country code for this Payment Method, to be used for better UX (e.g. group Open Banking links by country). Omitted if not relevant for this payment method. | |
| card_acceptor_id: | |
| type: string | |
| description: Only for card payments. It is the terminal name. | |
| terminal_id: | |
| type: string | |
| description: Only for card payments. | |
| PaymentReferenceResponse: | |
| type: object | |
| properties: | |
| account_name: | |
| type: string | |
| description: Processing Account name that was used to process thetransaction. | |
| order_reference: | |
| type: string | |
| description: Merchant’s order ID. | |
| email: | |
| type: string | |
| description: Customer’s email. | |
| customer_ip: | |
| type: string | |
| description: Customer’s IP address | |
| customer_url: | |
| type: string | |
| description: URL where the Customer should be redirected after completingthe payment, ```payment_reference``` and ```order_reference``` parameters are added when customer is redirected to ```customer_url```. Customer URL has to be a fully qualified domain name, it is notpossible to use an IP address or localhost. | |
| payment_created_at: | |
| type: string | |
| format: date-time | |
| description: Time when the payment was initiated at Payment Gateway. | |
| initial_amount: | |
| type: number | |
| description: Initial amount used for the transaction. | |
| standing_amount: | |
| type: number | |
| description: Payment standing amount. | |
| payment_reference: | |
| type: string | |
| description: Reference ID of the payment. | |
| payment_link: | |
| type: string | |
| api_username: | |
| type: string | |
| description: The api_username of the Merchant sending the request. | |
| stan: | |
| type: number | |
| description: Payment STAN number - a unique ID to identify payments onacquiring bank payment reports. | |
| fraud_score: | |
| type: number | |
| description: Payment fraud score. | |
| payment_state: | |
| type: string | |
| description: Current status of the payment. Possible values- "initial","waiting_for_sca",”sent_for_processing”,"waiting_for_3ds_response", "settled", "failed", "abandoned","voided", "refunded", "chargebacked" | |
| payment_method: | |
| type: string | |
| description: What payment method was used. See above Payment Methodsfor valid values here. Depending on the payment method, otherfields in the response would be present or omitted. Returnedwhen payment is completed. | |
| transaction_time: | |
| type: string | |
| format: date-time | |
| description: Time of the transaction. | |
| processing_error: | |
| $ref: '#/definitions/ProcessingError' | |
| ob_details: | |
| $ref: '#/definitions/PaymentReferenceResponseOb' | |
| cc_details: | |
| $ref: '#/definitions/CreditCardDetails' | |
| example: | |
| account_name: "EUR3D1" | |
| order_reference: "2020102938" | |
| email: null | |
| customer_ip: "195.50.210.227" | |
| customer_url: "https://aalux.ee/pangalink2" | |
| payment_created_at: "2020-10-29T20:35:36.554Z" | |
| initial_amount: 82.8 | |
| standing_amount: 82.8 | |
| payment_reference: "793c177f5fa3c3f48dd36a4e970cb7859558beec05361c254ee6f05f4e75fd26" | |
| payment_link: "https://igw-demo.every-pay.com/lp/62xjpi/8ZcPpd2Q" | |
| api_username: "19b149633d0c267f" | |
| stan: 707435 | |
| fraud_score: 0 | |
| payment_state: "settled" | |
| payment_method: "swed_ob_ee" | |
| transaction_time: "2020-10-29T20:36:00.189Z" | |
| ob_details: | |
| debtor_iban: "EE872200221001012135" | |
| creditor_iban: "EE717700771001735865" | |
| ob_payment_reference: "63dc14e8-42ed-42bc-9672-a39f39ffc01b" | |
| ob_payment_state: "ACSC" | |
| PaymentReferenceResponseOb: | |
| type: object | |
| description: Details for Open Banking payment | |
| properties: | |
| debtor_iban: | |
| type: string | |
| description: Customer IBAN which money is taken from (in case of SEPApayment). | |
| creditor_iban: | |
| type: string | |
| description: Merchant IBAN which money is sent to. | |
| ob_payment_reference: | |
| type: string | |
| description: Reference of the payment in the bank. | |
| ob_payment_state: | |
| type: string | |
| description: State of the payment in the bank. | |
| example: | |
| debtor_iban: "EE872200221001012135" | |
| creditor_iban: "EE717700771001735865" | |
| ob_payment_reference: "63dc14e8-42ed-42bc-9672-a39f39ffc01b" | |
| ob_payment_state: "ACSC" | |
| ProcessingError: | |
| type: object | |
| description: Details for processing error | |
| properties: | |
| code: | |
| type: number | |
| description: Processing error code | |
| message: | |
| type: string | |
| description: Processing error | |
| CreditCardDetails: | |
| type: object | |
| properties: | |
| token: | |
| type: string | |
| description: Token referencing a bank card that can later be used to initiaterecurring payments. It is returned only if the token was requestedwith ```request_token```. | |
| last_four_digits: | |
| type: number | |
| description: Last four digits of the card number. | |
| month: | |
| type: number | |
| description: Card expiration month (mm format - 1-2 digits). | |
| minimum: 1 | |
| maximum: 12 | |
| year: | |
| type: number | |
| pattern: 20[0-9]{2} | |
| description: Card expiration year (YYYY format - 4 digits). | |
| holder_name: | |
| type: string | |
| description: Name on the card. | |
| type: | |
| type: string | |
| pattern: visa|master_card | |
| description: Card type. Possible values are ‘visa’ or ‘master_card’. | |
| issuer_country: | |
| type: string | |
| pattern: [A-Z]{2} | |
| description: Card issuer country. ISO 3166 two-letter (alpha-2) format (e.g.EE). | |
| issuer: | |
| type: string | |
| description: Card issuing organization. | |
| cobrand: | |
| type: string | |
| description: Name of the cobrand | |
| funding_source: | |
| type: string | |
| pattern: debit|credit | |
| description: Funding source of the card. (debit or credit) | |
| product: | |
| type: string | |
| description: Product type of the card. | |
| state_3ds: | |
| type: string | |
| description: 3DS state of the transaction | |
| authorization_code: | |
| type: string | |
| description: Authorisation code of the transaction. | |
| example: | |
| token: "d841bcc672b0f76523a7fa13" | |
| last_four_digits: "1234" | |
| month: 1 | |
| year: 2020 | |
| holder_name: "Tom Smith" | |
| type: "master_card" | |
| issuer_country: "EE" | |
| issuer: "LHV Bank" | |
| cobrand: "Partner deebet" | |
| funding_source: "Debit" | |
| product: "DEBIT STANDARD" | |
| state_3ds: "no3ds" | |
| authorization_code: "00590A" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment