RaiAccept

https://docs.raiaccept.com
Admin
RaiAccept is a PCI-DSS and PSD2 compliant payment gateway that enables e-commerce platforms to...
Tokens:33,166
Snippets:194
Trust Score:5.4
Update:7 months ago
Show doc for...
Tokens:
Raw
### Example Transaction Status Response

Source: https://docs.raiaccept.com/code-integration.html

An example JSON response detailing a transaction's status, amount, currency, and associated merchant and order information. This structure is returned when successfully querying the transaction status endpoint.

```JSON
{
  "transaction": {
    "transactionId": "D-001-TX-ffa6c2b4-b1d7-431d-8452-ebf858b2b175",
    "transactionAmount": 2000.00,
    "transactionCurrency": "RSD",
    "isProduction": false,
    "transactionType": "REFUND",
    "paymentMethod": "CARD",
    "status": "SUCCESS",
    "statusCode": "0000",
    "statusMessage": "Success",
    "createdOn": "2023-01-05T10:00:18Z",
    "updatedOn": "2023-01-05T10:00:19Z"
  },
  "merchant": {
    "merchantAccountId": "D-001-MA-HfDqSZwd",
    "statementDescriptorShortVersion": "agrolivana"
  },
  "order": {
    "orderIdentification": "D-001-ORD-edf3e8b2-8b0e-404a-b55a-e6b3c2dd7780",
    "invoice": {
      "merchantOrderReference": "12345678922",
      "description": "Test Order"
    }
  },
  "card": {
    "maskedCardNumber": "512070******0019",
    "cardHolderName": "Milica Petrovic",
    "type": "MASTERCARD",
    "issuerCountry": "UKR",
    "cardToken": "0e46b504-c5c4-4072-a624-0aec4d8a39b7"
  }
}
```

--------------------------------

### Example Order Details Response

Source: https://docs.raiaccept.com/code-integration.html

This JSON object represents a successful response when retrieving order details from the RaiAccept API. It includes information about the order identification, payment method preference, merchant details, creation timestamp, consumer information, invoice details, shipping and billing addresses, callback URLs, and the order status.

```JSON
{
    "orderIdentification": "D-001-ORD-d94e7447-494e-43ad-a460-5cd94b3fb0d8",
    "paymentMethodPreference": "CARD",
    "merchant": {
        "merchantAccountId": "D-001-MA-vGWWZLm4",
        "statementDescriptorShortVersion": "yourShopName"
    },
    "createdOn": "2022-09-14T20:27:27Z",
    "consumer": {
        "firstName": "Milica",
        "lastName": "Petrovic",
        "email": "milica@petrovic.rs",
        "mobilePhone": "+381113202100",
        "phone": "",
        "workPhone": "",
        "ipAddress": ""
        },
    "invoice": {
        "merchantOrderReference": "1551764626669",
        "amount": 4000.00,
        "currency": "RSD",
        "description": "Test Order",
        "items": [
            {
                "numberOfItems": 1,
                "price": 4000.00,
                "description": "ItemA"
            }
        ]
    },
    "shippingAddress": {
        "firstName": "Milica",
        "lastName": "Petrovic",
        "addressStreet1": "Resavska 1",
        "addressStreet2": "",
        "addressStreet3": "",
        "postalCode": "11000",
        "city": "Beograd",
        "state": "",
        "country": "SRB"
    },
    "billingAddress": {
        "firstName": "Milica",
        "lastName": "Petrovic",
        "addressStreet1": "Resavska 1",
        "addressStreet2": "",
        "addressStreet3": "",
        "postalCode": "11000",
        "city": "Beograd",
        "state": "",
        "country": "SRB"
    },
    "callbackUrls": {
        "successUrl": " https://yourshopname.rs/success/?orderId=1521348554419&headless=true",
        "failUrl": " https://yourshopname.rs/error/?orderId=1521348554419&headless=true",
        "cancelUrl": " https://yourshopname.rs/cancel/?orderId=1521348554419&headless=true",
        "notificationUrl": "https://webhook.site/cb7f55c6-e7aa-49dd-9d28-a22333cc1551"
    },
    "isProduction": false,
    "linkId": "string",
    "status": "DRAFT",
    "recurring": {
        "cardToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "customerReference": "string",
        "recurringModel": "NONE"
    }
}
```

--------------------------------

### RaiAccept Notification Webhook Example Payload

Source: https://docs.raiaccept.com/code-integration.html

An example JSON payload representing a transaction notification webhook from RaiAccept. This payload contains detailed information about the transaction, merchant, order, consumer, card, and callback URLs.

```json
{
  "transaction": {
    "transactionId": "R-001-TX-ab2301a6-104c-436e-bf60-ccc0bc9d6ae2",
    "transactionAmount": 4000,
    "transactionCurrency": "RSD",
    "isProduction": false,
    "transactionType": "PURCHASE",
    "paymentMethod": "CARD",
    "status": "SUCCESS",
    "statusCode": "0000",
    "statusMessage": "Success",
    "createdOn": "2023-03-08T10:19:55Z",
    "updatedOn": "2023-03-08T10:19:56Z"
  },
  "merchant": {
    "merchantAccountId": "D-001-MA-QkoC2XyB",
    "statementDescriptorShortVersion": ""
  },
  "order": {
    "orderIdentification": "R-001-ORD-d68b0e14-66c0-4a89-940a-9438cf5e2e57",
    "preferredPaymentMethod": "CARD",
    "invoice": {
      "merchantOrderReference": "12345678940",
      "description": "Test Order",
      "items": [
        {
          "numberOfItems": 1,
          "price": 4000,
          "description": "ItemA"
        }
      ]
    },
    "consumer": {
      "firstName": "Milica",
      "lastName": "Petrovic",
      "email": "milica@petrovic.rs"
    }
  }
}
```

--------------------------------

### POST /websites/raiaccept

Source: https://docs.raiaccept.com/code-integration.html

Creates a checkout session for a transaction. This endpoint requires detailed information about the order, customer, and desired payment method.

```APIDOC
## POST /websites/raiaccept

### Description
Creates a checkout session for a transaction. This endpoint requires detailed information about the order, customer, and desired payment method.

### Method
POST

### Endpoint
/websites/raiaccept

### Parameters
#### Request Body
- **urls** (object) - Required - Contains redirect URLs for success, cancellation, and failure.
  - **successUrl** (string) - Required - Frontend redirect after a successful transaction.
  - **cancelUrl** (string) - Required - Frontend redirect if the consumer cancels the checkout process.
  - **failUrl** (string) - Required - Frontend redirect if the transaction fails.
  - **notificationUrl** (string) - Optional - Backend URL to receive webhook notifications on transaction status changes.
- **invoice** (object) - Required - Details of the invoice.
  - **amount** (number) - Required - The total amount of the transaction.
  - **currency** (string) - Required - The currency of the transaction (e.g., 'RSD').
  - **description** (string) - Optional - A description of the order.
  - **merchantOrderReference** (string) - Required - The merchant's unique order reference.
  - **items** (array) - Optional - A list of items included in the order.
    - **description** (string) - Required - Description of the item.
    - **numberOfItems** (number) - Required - Quantity of the item.
    - **price** (number) - Required - Price of the item.
- **billingAddress** (object) - Optional - Billing address details.
  - **addressStreet1** (string) - Required - Street address line 1.
  - **city** (string) - Required - City.
  - **country** (string) - Required - Country code (e.g., 'SRB').
  - **postalCode** (string) - Required - Postal code.
  - **firstName** (string) - Required - First name.
  - **lastName** (string) - Required - Last name.
  - **addressStreet2** (string) - Optional - Street address line 2.
  - **addressStreet3** (string) - Optional - Street address line 3.
  - **state** (string) - Optional - State or province.
- **shippingAddress** (object) - Optional - Shipping address details (same fields as billingAddress).
- **consumer** (object) - Optional - Consumer details.
  - **email** (string) - Optional - Consumer's email address.
  - **firstName** (string) - Optional - Consumer's first name.
  - **lastName** (string) - Optional - Consumer's last name.
  - **mobilePhone** (string) - Optional - Consumer's mobile phone number.
  - **ipAddress** (string) - Optional - Consumer's IP address.
  - **phone** (string) - Optional - Consumer's phone number.
  - **workPhone** (string) - Optional - Consumer's work phone number.
- **paymentMethodPreference** (string) - Optional - Preferred payment method (e.g., 'CARD').
- **recurring** (object) - Optional - Parameters for recurring payments.
  - **cardToken** (string) - Optional - Payment card token.
  - **customerReference** (string) - Optional - ID of the consumer in the Merchant's database.
  - **recurringModel** (string) - Optional - Type of recurring model ('NONE', 'ONE_CLICK_CHECKOUT').
- **linkId** (string) - Optional - ID of the payment link, if used.
- **merchant** (object) - Required - Merchant information.
  - **merchantAccountId** (string) - Required - Merchant Account ID.
  - **statementDescriptorShortVersion** (string) - Required - Merchant name displayed on the payment form.
- **isProduction** (boolean) - Required - Set to true for production environment, false for sandbox.
- **createdOn** (string) - Required - Date and time of order creation in `YYYY-MM-DDTHH:MM:SSZ` format.

### Request Example
```json
{
    "billingAddress": {
        "addressStreet1": "Resavska 1",
        "city": "Beograd",
        "country": "SRB",
        "postalCode": "11000",
        "firstName": "Milica",
        "lastName": "Petrovic"
    },
    "consumer": {
        "email": "milica@petrovic.rs",
        "firstName": "Milica",
        "lastName": "Petrovic",
        "mobilePhone": "+381113202100"
    },
    "invoice": {
        "amount": 4000,
        "currency": "RSD",
        "description": "Test Order",
        "merchantOrderReference": "12345678927",
        "items": [
            {
                "description": "ItemA",
                "numberOfItems": 1,
                "price": 4000
            }
        ]
    },
    "paymentMethodPreference": "CARD",
    "shippingAddress": {
        "addressStreet1": "Resavska 1",
        "city": "Beograd",
        "country": "SRB",
        "postalCode": "11000",
        "firstName": "Milica",
        "lastName": "Petrovic"
    },
    "urls": {
        "cancelUrl": "https://yourshopname.rs/cancel/?orderId=1521348554419&headless=true",
        "failUrl": "https://yourshopname.rs/error/?orderId=1521348554419&headless=true",
        "notificationUrl": "https://webhook.site/cb7f55c6-e7aa-49dd-9d28-a22333cc1551",
        "successUrl": "https://yourshopname.rs/success/?orderId=1521348554419&headless=true"
    },
    "linkId": "string",
    "recurring": {
        "cardToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "customerReference": "string",
        "recurringModel": "NONE"
    },
    "merchant": {
        "merchantAccountId": "D-001-MA-vGWWZLm4",
        "statementDescriptorShortVersion": "yourShopName"
    },
    "isProduction": true,
    "createdOn": "2022-09-14T16:20:07Z"
}
```

### Response
#### Success Response (201)
- **orderIdentification** (string) - The unique identifier for the created order.
- **paymentMethodPreference** (string) - The preferred payment method for the order.
- **merchant** (object) - Merchant details.
  - **merchantAccountId** (string) - The merchant's account ID.
  - **statementDescriptorShortVersion** (string) - The merchant name displayed on the payment form.
- **createdOn** (string) - The date and time the order was created.

#### Response Example
```json
{
    "orderIdentification": "D-001-ORD-3833f9de-551c-443b-9034-279e73051ed1",
    "paymentMethodPreference": "CARD",
    "merchant": {
        "merchantAccountId": "D-001-MA-vGWWZLm4",
        "statementDescriptorShortVersion": "yourShopName"
    },
    "createdOn": "2022-09-14T16:20:07Z"
}
```

#### Error Responses
- **400** - Bad Request: HTTP request message reading or validation failed.
- **401** - Unauthorized: Authentication error.
- **403** - Forbidden: MerchantAccountId is invalid or does not belong to this user.
- **404** - Not Found: HTTP request does not match any handler available by server or object not found.
- **405** - Method Not Allowed: HTTP method not allowed.
- **406** - Not Acceptable: Not acceptable.
- **409** - Conflict: Authentication error.
- **410** - Gone: Authentication error.
- **415** - Unsupported Media Type: Unsupported media type.
- **500** - Internal Server Error: Internal server error or misconfiguration.
```

--------------------------------

### 1. Authentication API

Source: https://docs.raiaccept.com/code-integration.html

Authenticates merchant credentials using Amazon Cognito to obtain an authentication token for subsequent API calls.

```APIDOC
## POST /authenticate.raiaccept.com

### Description
Authenticates merchant credentials using Amazon Cognito to obtain an authentication token for subsequent API calls.

### Method
POST

### Endpoint
`https://authenticate.raiaccept.com`

### Parameters
#### Headers
- **Content-Type** (string) - Required - `application/x-amz-json-1.1`
- **X-Amz-Target** (string) - Required - `AWSCognitoIdentityProviderService.InitiateAuth`

#### Request Body
- **AuthFlow** (string) - Required - `USER_PASSWORD_AUTH`
- **AuthParameters** (object) - Required - Contains authentication credentials.
  - **USERNAME** (string) - Required - Merchant's API username.
  - **PASSWORD** (string) - Required - Merchant's API password.
- **ClientId** (string) - Required - `kr2gs4117arvbnaperqff5dml`

### Request Example
```json
{
  "AuthFlow": "USER_PASSWORD_AUTH",
  "AuthParameters": {
    "USERNAME": "1eab1b61-525f-45c5-97dc-1a57b01a1c14",
    "PASSWORD": "chMkiMwP%+1_c?Jl(4bg5Xs8WbN3(2-<)kB"
  },
  "ClientId": "kr2gs4117arvbnaperqff5dml"
}
```

### Response
#### Success Response (200)
- **IdToken** (string) - The authentication token to be used in subsequent API requests.

#### Response Example
```json
{
  "IdToken": "eyJ..."
}
```

#### Negative Responses
Refer to Amazon API reference for a complete list of negative responses.
```

--------------------------------

### POST /authenticate.raiaccept.com

Source: https://docs.raiaccept.com/code-integration.html

Authenticates the merchant using Amazon Cognito to obtain an authentication token.

```APIDOC
## POST /authenticate.raiaccept.com

### Description
Authenticates the merchant using Amazon Cognito to obtain an authentication token. This token is used for subsequent API communications.

### Method
POST

### Endpoint
https://authenticate.raiaccept.com

### Parameters
#### Headers
- **Content-Type** (string) - Required - `application/x-amz-json-1.1`
- **X-Amz-Target** (string) - Required - `AWSCognitoIdentityProviderService.InitiateAuth`

#### Request Body
- **AuthFlow** (string) - Required - `USER_PASSWORD_AUTH`
- **AuthParameters** (object) - Required
  - **USERNAME** (string) - Required - Username (API credentials).
  - **PASSWORD** (string) - Required - Password (API credentials).
- **ClientId** (string) - Required - `kr2gs4117arvbnaperqff5dml`

### Request Example
```json
{
  "AuthFlow": "USER_PASSWORD_AUTH",
  "AuthParameters": {
    "USERNAME": "1eab1b61-525f-45c5-97dc-1a57b01a1c14",
    "PASSWORD": "chMkiMwP%+1_c?Jl(4bg5Xs8WbN3(2-<)kB"
  },
  "ClientId": "kr2gs4117arvbnaperqff5dml"
}
```

### Response
#### Success Response (200)
- **IdToken** (string) - The authentication token to be used for subsequent API requests.

#### Response Example
```json
{
  "IdToken": "<your_id_token>"
}
```
```

--------------------------------

### Initiate Refund API Request

Source: https://docs.raiaccept.com/code-integration.html

This section outlines the process for issuing a refund via the API. It involves authenticating to obtain a token and then making a request to refund an order. Note that refunds cannot exceed the original transaction amount and must be in the same currency.

```Conceptual
# 1. Perform authentication and retrieve token
# (Refer to Authentication documentation for details)

# 2. Issue a refund for an order ID
# POST /orders/{OrderID}/refunds
# Request body would contain refund details (e.g., amount, currency)

# 3. (OPTIONAL) Retrieve refund status by order ID
# GET /orders/{OrderID}/refunds/{RefundId}
```

--------------------------------

### Create Order and Checkout with One-Click

Source: https://docs.raiaccept.com/one-click-checkout.html

This endpoint is used to create an order and initiate the checkout process, enabling the one-click checkout feature for returning customers.

```APIDOC
## POST /orders and POST /orders/{orderIdentification}/checkout

### Description
Initiates the checkout process and allows returning customers to complete purchases using saved card details. This is achieved by setting the `recurringModel` to `ONE_CLICK_CHECKOUT`.

### Method
POST

### Endpoint
`https://trapi.raiaccept.com/orders`
`https://trapi.raiaccept.com/orders/{orderIdentification}/checkout`

### Parameters
#### Request Body
- **recurring** (object) - Optional - Parameters used to revoke the consumer's previously saved payment card for one-click checkout.
  - **customerReference** (string) - Optional - ID of the consumer in the Merchant's database (0-64 characters).
  - **recurringModel** (string) - Optional - Set to `ONE_CLICK_CHECKOUT` to display the **Save card details for future purchases** option.

### Request Example
```json
{
    "recurring": {
        "customerReference": "string",
        "recurringModel": "ONE_CLICK_CHECKOUT"
    }
}
```

### Response
#### Success Response (201)
- **recurring** (object) - Contains details about the recurring payment setup.
  - **cardToken** (string) - Payment card token.
  - **customerReference** (string) - ID of the consumer in the Merchant's database.
  - **recurringModel** (string) - The recurring model used (`ONE_CLICK_CHECKOUT`).

#### Response Example
```json
{
    "recurring": {
        "cardToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "customerReference": "string",
        "recurringModel": "ONE_CLICK_CHECKOUT"
    }
}
```
```

--------------------------------

### GET /orders/{OrderID}/transactions/{TransactionId}

Source: https://docs.raiaccept.com/code-integration.html

Retrieves the transaction details and status from RaiAccept for a given OrderID and TransactionId.

```APIDOC
## GET /orders/{OrderID}/transactions/{TransactionId}

### Description
Retrieves the transaction details and status from RaiAccept.

### Method
GET

### Endpoint
`https://trapi.raiaccept.com/orders/{OrderID}/transactions/{TransactionId}`

### Parameters
#### Path Parameters
- **OrderID** (string) - Required - The unique identifier for the order.
- **TransactionId** (string) - Required - The unique identifier for the transaction.

#### Query Parameters
None

#### Request Body
This endpoint does not accept a request body.

### Request Example
None

### Response
#### Success Response (200)
- **transaction** (object) - Details about the transaction.
  - **transactionId** (string) - Unique RaiAccept transaction ID.
  - **transactionAmount** (number) - Total transaction amount.
  - **transactionCurrency** (string) - Transaction currency in ISO 4217 alphabetic currency code.
  - **isProduction** (boolean) - Indicates if the request is made in the production environment.
  - **transactionType** (string) - Transaction type (`PURCHASE` or `REFUND`).
  - **paymentMethod** (string) - Payment type (`CARD`).
  - **status** (string) - Status of the transaction (`DRAFT`, `PENDING`, `SUCCESS`, `FAILED`).
  - **statusCode** (string) - Code indicating the transaction result (`0000` for success).
  - **statusMessage** (string) - Description of the transaction result.
  - **createdOn** (string) - Date and time of order creation in `YYYY-MM-DDTHH:MM:SSZ` format (UTC).
  - **updatedOn** (string) - Date and time of the last order update in `YYYY-MM-DDTHH:MM:SSZ` format (UTC).
- **merchant** (object) - Merchant details.
  - **merchantAccountId** (string) - Merchant Account ID.
  - **statementDescriptorShortVersion** (string) - Merchant name displayed in the RaiAccept payment form.
- **order** (object) - Order details.
  - **orderIdentification** (string) - RaiAccept order ID.
  - **invoice** (object) - Invoice details.
    - **merchantOrderReference** (string) - Merchant’s order number.
    - **description** (string) - Order description.
- **card** (object) - Payment card details.
  - **maskedCardNumber** (string) - Card number with masked digits.
  - **cardHolderName** (string) - Card holder's name.
  - **type** (string) - Card type (e.g., Visa or MasterCard).
  - **issuerCountry** (string) - Country where the card was issued.
  - **cardToken** (string) - Tokenized version of the card number.
  - **cardSavingApproved** (boolean) - Consent given by the consumer to save the card number.
  - **expiryMonth** (string) - Month of expiration of the card.
  - **expiryYear** (string) - Year of expiration of the card.

#### Response Example
```json
{
  "transaction": {
    "transactionId": "D-001-TX-ffa6c2b4-b1d7-431d-8452-ebf858b2b175",
    "transactionAmount": 2000.00,
    "transactionCurrency": "RSD",
    "isProduction": false,
    "transactionType": "REFUND",
    "paymentMethod": "CARD",
    "status": "SUCCESS",
    "statusCode": "0000",
    "statusMessage": "Success",
    "createdOn": "2023-01-05T10:00:18Z",
    "updatedOn": "2023-01-05T10:00:19Z"
  },
  "merchant": {
    "merchantAccountId": "D-001-MA-HfDqSZwd",
    "statementDescriptorShortVersion": "agrolivana"
  },
  "order": {
    "orderIdentification": "D-001-ORD-edf3e8b2-8b0e-404a-b55a-e6b3c2dd7780",
    "invoice": {
      "merchantOrderReference": "12345678922",
      "description": "Test Order"
    }
  },
  "card": {
    "maskedCardNumber": "512070******0019",
    "cardHolderName": "Milica Petrovic",
    "type": "MASTERCARD",
    "issuerCountry": "UKR",
    "cardToken": "0e46b504-c5c4-4072-a624-0aec4d8a39b7"
  }
}
```
```

--------------------------------

### Apple Pay Domain Association File Hosting Structure

Source: https://docs.raiaccept.com/apple-pay.html

This snippet illustrates the required directory structure and file name for hosting the Apple Pay domain association file. The file must be placed in the /.well-known/ directory and named 'apple-developer-merchantid-domain-association'.

```text
/.well-known/
apple-developer-merchantid-domain-association
```

--------------------------------

### GET /orders/{OrderID}/transactions/{TransactionId}

Source: https://docs.raiaccept.com/code-integration.html

Retrieves the refund (transaction) details and status from RaiAccept. This endpoint is used to check the status of a specific transaction.

```APIDOC
## GET /orders/{OrderID}/transactions/{TransactionId}

### Description
Retrieves the refund (transaction) details and status from RaiAccept. This endpoint is used to check the status of a specific transaction.

### Method
GET

### Endpoint
`https://trapi.raiaccept.com/orders/{OrderID}/transactions/{TransactionId}`

### Parameters
#### Path Parameters
- **OrderID** (string) - Required - The unique identifier for the order.
- **TransactionId** (string) - Required - The unique identifier for the transaction.

#### Query Parameters
None

#### Request Body
**Send request without body.**

### Request Example
None

### Response
#### Success Response (200)
- **transaction** (object) - Details of the transaction.
  - **transactionId** (string) - Unique RaiAccept transaction ID.
  - **transactionAmount** (number) - Total transaction amount.
  - **transactionCurrency** (string) - Transaction currency in ISO 4217 alphabetic currency code.
  - **isProduction** (boolean) - If true, the request is made in the production environment.
  - **transactionType** (string) - Transaction type (`PURCHASE` or `REFUND`).
  - **paymentMethod** (string) - Payment type (fixed value `CARD`).
  - **status** (string) - Status of the transaction (`DRAFT`, `PENDING`, `SUCCESS`, `FAILED`).
  - **statusCode** (string) - Code indicating the transaction result.
  - **statusMessage** (string) - Description of the transaction result.
  - **createdOn** (string) - Date and time of creation in `YYYY-MM-DDTHH:MM:SSZ` format, UTC time.
  - **updatedOn** (string) - Date and time of the last update in `YYYY-MM-DDTHH:MM:SSZ` format, UTC time.
- **merchant** (object) - Merchant details.
  - **merchantAccountId** (string) - Merchant Account ID.
  - **statementDescriptorShortVersion** (string) - Merchant name displayed in the RaiAccept payment form.
- **order** (object) - Order details.
  - **orderIdentification** (string) - RaiAccept order ID.
  - **invoice** (object) - Invoice details.
    - **merchantOrderReference** (string) - Merchant’s order number.
    - **description** (string) - Order description.
- **card** (object) - Payment card details.
  - **maskedCardNumber** (string) - Card number with masked digits.
  - **cardHolderName** (string) - Card holder's name.
  - **type** (string) - Card type (e.g., Visa or MasterCard).
  - **issuerCountry** (string) - Country where the card was issued.
  - **cardToken** (string) - Tokenized version of the card number.
  - **cardSavingApproved** (boolean) - Consent to save the card number for later use.
  - **expiryMonth** (string) - Month of expiration of the card.
  - **expiryYear** (string) - Year of expiration of the card.

#### Response Example
```json
{
  "transaction": {
    "transactionId": "D-001-TX-ffa6c2b4-b1d7-431d-8452-ebf858b2b175",
    "transactionAmount": 2000.00,
    "transactionCurrency": "RSD",
    "isProduction": false,
    "transactionType": "REFUND",
    "paymentMethod": "CARD",
    "status": "SUCCESS",
    "statusCode": "0000",
    "statusMessage": "Success",
    "createdOn": "2023-01-05T10:00:18Z",
    "updatedOn": "2023-01-05T10:00:19Z"
  },
  "merchant": {
    "merchantAccountId": "D-001-MA-HfDqSZwd",
    "statementDescriptorShortVersion": "agrolivana"
  },
  "order": {
    "orderIdentification": "D-001-ORD-edf3e8b2-8b0e-404a-b55a-e6b3c2dd7780",
    "invoice": {
      "merchantOrderReference": "12345678922",
      "description": "Test Order"
    }
  },
  "card": {
    "maskedCardNumber": "512070******0019",
    "cardHolderName": "Milica Petrovic",
    "type": "MASTERCARD",
    "issuerCountry": "UKR",
    "cardToken": "0e46b504-c5c4-4072-a624-0aec4d8a39b7"
  }
}
```
```

--------------------------------

### Create Payment Session Request

Source: https://docs.raiaccept.com/code-integration.html

This snippet demonstrates the structure of a POST request to create a payment session. It includes authorization headers and a JSON body with order details, consumer information, billing and shipping addresses, and URLs for payment status notifications. The 'allowedPaymentMethods' field can be optionally included to control available payment options.

```json
{
    "Authorization":"Bearer [IdToken]"
}
{
    "billingAddress": {
        "addressStreet1": "Resavska 1",
        "addressStreet2": "",
        "addressStreet3": "",
        "city": "Beograd",
        "country": "SRB",
        "firstName": "Milica",
        "lastName": "Petrovic",
        "postalCode": "11000",
        "state": ""
    },
    "consumer": {
        "email": "milica@petrovic.rs",
        "firstName": "Milica",
        "ipAddress": "",
        "lastName": "Petrovic",
        "mobilePhone": "+381113202100",
        "phone": "",
        "workPhone": ""
    },
    "invoice": {
        "amount": 4000,
        "currency": "RSD",
        "description": "Test Order",
        "items": [
            {
                "description": "ItemA",
                "numberOfItems": 1,
                "price": 4000
            }
        ],
        "merchantOrderReference": "{{MerchantOrderRef}}"
    },
    "paymentMethodPreference": "CARD",
    "shippingAddress": {
        "addressStreet1": "Resavska 1",
        "addressStreet2": "",
        "addressStreet3": "",
        "city": "Beograd",
        "country": "SRB",
        "firstName": "Milica",
        "lastName": "Petrovic",
        "postalCode": "11000",
        "state": ""
    },
    "urls": {
        "cancelUrl": "https://yourshopname.rs/cancel/?orderId=1521348554419&headless=true",
        "failUrl": "https://yourshopname.rs/error/?orderId=1521348554419&headless=true",
        "notificationUrl": "https://webhook.site/cb7f55c6-e7aa-49dd-9d28-a22333cc1551",
        "successUrl": "https://yourshopname.rs/success/?orderId=1521348554419&headless=true"
    },
    "linkId": "string",
    "recurring": {
        "cardToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "customerReference": "string",
        "recurringModel": "NONE"
    },
    "allowedPaymentMethods": ["APPLE_PAY", "GOOGLE_PAY"]
}
```

--------------------------------

### Enable One-Click Checkout in Order Creation (JSON)

Source: https://docs.raiaccept.com/one-click-checkout.html

This snippet demonstrates how to include the 'recurring' object with 'customerReference' and 'recurringModel' set to 'ONE_CLICK_CHECKOUT' in a POST request to create an order. This enables the 'Save card details for future purchases' option for the consumer.

```json
{
    "recurring": {
        "customerReference": "string",
        "recurringModel": " ONE_CLICK_CHECKOUT"
    }
}
```

--------------------------------

### POST /orders/{OrderID}/transactions/{TransactionId}/refund

Source: https://docs.raiaccept.com/code-integration.html

Issues a refund for a specific order and transaction. Refunds can be partial or full.

```APIDOC
## POST /orders/{OrderID}/transactions/{TransactionId}/refund

### Description
Issues a refund for a specific order and transaction. Refunds can be partial or full. The refund is referenced to the purchase OrderID and TransactionId.

### Method
POST

### Endpoint
https://trapi.raiaccept.com/orders/{OrderID}/transactions/{TransactionId}/refund

### Parameters
#### Path Parameters
- **OrderID** (string) - Required - The ID of the order for which to issue a refund.
- **TransactionId** (string) - Required - The ID of the transaction to refund.

#### Query Parameters
None

#### Request Body
- **amount** (number) - Required - Refund amount. Must be greater than 0 and not exceed the original purchase amount.
- **currency** (string) - Required - Refund currency. Must be the same as the original transaction currency.

### Request Example
```json
{
  "amount": 4000,
  "currency": "RSD"
}
```

### Response
#### Success Response (200)
- **transactionId** (string) - The ID of the successful refund transaction.

#### Response Example
```json
{
  "transactionId": "D-001-TX-beab6179-f357-477d-ac7d-3e8b41100a65"
}
```
```

--------------------------------

### Verify Apple Pay Domain Association File with cURL

Source: https://docs.raiaccept.com/apple-pay.html

This command-line snippet demonstrates how to verify the accessibility and content of the Apple Pay domain association file hosted on your server. It ensures the file is served correctly over HTTPS with a 200 OK status.

```shell
curl -i https://[YOUR_DOMAIN]/.well-known/apple-developer-merchantid-domain-association
```

--------------------------------

### POST /orders - Create Order Entry

Source: https://docs.raiaccept.com/code-integration.html

Creates an order database entry in the RaiAccept system with a unique order ID. The response includes original parameters plus order identification, merchant account ID, and a short descriptor for the consumer.

```APIDOC
## POST /orders

### Description
Creates an order database entry with a unique order ID in the RaiAccept system. The response includes original parameters and additional details like order identification, merchant account ID, and a consumer-facing merchant descriptor.

### Method
POST

### Endpoint
`https://trapi.raiaccept.com/orders`

### Headers
- **Authorization** (string) - Required - Bearer **IdToken** (from Authentication)
- **Content-Type** (string) - Required - `application/json`

### Parameters
#### Request Body
- **consumer** (object) - Optional - Consumer's details.
  - **firstName** (string) - Optional (0-32) - Only letters, hyphens, apostrophes, periods.
  - **lastName** (string) - Optional (0-32) - Only letters, hyphens, apostrophes, periods.
  - **email** (string) - Recommended (0-255) - Requires a valid email format (with `@` symbol).
  - **mobilePhone** (string) - Recommended (0-15) - Accepts both `+381` and `00381` formats, without spaces.
  - **phone** (string) - Optional (0-15) - Accepts both `+381` and `00381` formats, without spaces.
  - **workPhone** (string) - Optional (0-15) - Accepts both `+381` and `00381` formats, without spaces.
  - **ipAddress** (string) - Recommended (0-255)
- **billingAddress** (object) - Consumer’s billing address.
  - **firstName** (string) - Recommended (0-32) - Only letters, hyphens, apostrophes, periods.
  - **lastName** (string) - Recommended (0-32) - Only letters, hyphens, apostrophes, periods.
  - **addressStreet1** (string) - Recommended (0-50) - Accepts letters, numbers, hyphens, apostrophes, periods, slashes, commas.
  - **addressStreet2** (string) - Optional (0-50)
  - **addressStreet3** (string) - Optional (0-50)
  - **city** (string) - Recommended (0-50) - Accepts letters, numbers, hyphens, apostrophes, periods, slashes, commas.
  - **postalCode** (string) - Recommended (0-16) - Only alphanumerical characters, hyphens.
  - **country** (string-ENUM) - Recommended - ISO 3166-1 alpha-3 country code.
  - **State** (string) - Optional (0-3) - Accepts letters, numbers, hyphens, apostrophes, periods, slashes, commas.
- **invoice** (object) - Required
  - **amount** (number) - Required (more than 0) - Total invoice amount.
  - **currency** (string-ENUM) - Required - ISO 4217 alphabetic currency code.
  - **description** (string) - Optional (0-200) - Order description.
  - **merchantOrderReference** (string) - Required (1-150) - Merchant’s order number. Must be unique. Only alphanumeric characters, hyphens, and underscores allowed.
  - **items** (array) - Optional
    - **description** (string) - Optional (0-100) - Item name.
    - **numberOfItems** (integer) - Required - Number of items.
    - **price** (number) - Required (more than 0) - Price of one item.
- **paymentMethodPreference** (string-ENUM) - Required - The payment method to request for the checkout session. Supported values: `CARD`, `GOOGLE_PAY`, `APPLE_PAY`.
- **allowedPaymentMethods** (array of string-ENUM) - Optional - Limits which wallet payment methods are available. Supported values: `APPLE_PAY`, `GOOGLE_PAY`.
- **shippingAddress** (object) - Consumer’s shipping address.
  - **firstName** (string) - Recommended (0-32) - Only letters, hyphens, apostrophes, periods.
  - **lastName** (string) - Recommended (0-32) - Only letters, hyphens, apostrophes, periods.
  - **addressStreet1** (string) - Recommended (0-50) - Accepts letters, numbers, hyphens, apostrophes, periods, slashes, commas.
  - **addressStreet2** (string) - Optional (0-50)
  - **addressStreet3** (string) - Optional (0-50)
  - **city** (string) - Recommended (0-50) - Accepts letters, numbers, hyphens, apostrophes, periods, slashes, commas.
  - **postalCode** (string) - Recommended (0-16) - Only alphanumerical characters, hyphens.
  - **country** (string-ENUM) - Recommended - ISO 3166-1 alpha-3 country code.
  - **State** (string) - Recommended (0-3) - Accepts letters, numbers, hyphens, apostrophes, periods, slashes, commas.
- **urls** (object) - Frontend URLs.
  - **successUrl** (string) - Required - Must use `https://` prefix.
  - **cancelUrl** (string) - Required - Must use `https://` prefix.
  - **failUrl** (string) - Required - Must use `https://` prefix.
  - **notificationUrl** (string) - Required - Webhook URL for transaction status.

### Request Example
```json
{
  "consumer": {
    "email": "test@example.com",
    "mobilePhone": "+381601234567",
    "ipAddress": "192.168.1.1"
  },
  "billingAddress": {
    "firstName": "John",
    "lastName": "Doe",
    "addressStreet1": "123 Main St",
    "city": "Belgrade",
    "postalCode": "11000",
    "country": "SRB"
  },
  "invoice": {
    "amount": 100.50,
    "currency": "EUR",
    "merchantOrderReference": "ORDER-12345",
    "items": [
      {
        "description": "Product A",
        "numberOfItems": 1,
        "price": 50.25
      }
    ]
  },
  "paymentMethodPreference": "CARD",
  "urls": {
    "successUrl": "https://example.com/success",
    "cancelUrl": "https://example.com/cancel",
    "failUrl": "https://example.com/fail",
    "notificationUrl": "https://example.com/webhook"
  }
}
```

### Response
#### Success Response (200)
- **orderIdentification** (string) - The unique order ID generated by RaiAccept.
- **merchantAccountId** (string) - The merchant account ID.
- **statementDescriptorShortVersion** (string) - The merchant identification displayed to the consumer.
- Other original parameters sent in the request.

#### Response Example
```json
{
  "orderIdentification": "ord_123abc456def",
  "merchantAccountId": "merch_xyz789",
  "statementDescriptorShortVersion": "MyAwesomeShop",
  "consumer": {
    "email": "test@example.com",
    "mobilePhone": "+381601234567",
    "ipAddress": "192.168.1.1"
  },
  "billingAddress": {
    "firstName": "John",
    "lastName": "Doe",
    "addressStreet1": "123 Main St",
    "city": "Belgrade",
    "postalCode": "11000",
    "country": "SRB"
  },
  "invoice": {
    "amount": 100.50,
    "currency": "EUR",
    "merchantOrderReference": "ORDER-12345",
    "items": [
      {
        "description": "Product A",
        "numberOfItems": 1,
        "price": 50.25
      }
    ]
  },
  "paymentMethodPreference": "CARD",
  "urls": {
    "successUrl": "https://example.com/success",
    "cancelUrl": "https://example.com/cancel",
    "failUrl": "https://example.com/fail",
    "notificationUrl": "https://example.com/webhook"
  }
}
```
```
Tokens:
Raw