Mint Payments API

https://mint-payments.readme.io/reference/
Admin
The Mint Payments API is a RESTful API that enables applications to process a wide range of...
Tokens:186,857
Snippets:2,002
Trust Score:9.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example Customer Object

Source: https://mint-payments.readme.io/reference/getbookingbyid

An example of a customer object with all its properties.

```json
{
  "first_name": "Sienna",
  "last_name": "Harper",
  "email": "sienna.harper@example.com",
  "phone": "+447911123456",
  "address": "Unit 1",
  "address2": "123 High Street",
  "city": "London",
  "state": "Greater London",
  "postcode": "SW1A 1AA",
  "country": "GB"
}
```

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

### Authentication Header Example

Source: https://mint-payments.readme.io/reference/getting-started-with-your-api

This code snippet shows how to include your API key in the Authorization header for requests.

```http
Authorization: Bearer {your-api-key}
```

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

### Example Amount Object

Source: https://mint-payments.readme.io/reference/getbookingbyid

An example of an amount object specifying currency and value.

```json
{
  "currency": "GBP",
  "value": "1250.00"
}
```

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

### Booking Schema Example

Source: https://mint-payments.readme.io/reference/getbookingbyid

An example of a successful booking response, detailing all fields and their expected values.

```json
{
  "id": "BK.9p64FIO7Vhmq1r0ov9Hje9",
  "business_unit": "BU.01HVZ8QMT38FV2T3QPY9E7",
  "booking_reference": "REF240001",
  "amount_total": {
    "currency": "GBP",
    "value": "2500.00"
  },
  "customer": {
    "first_name": "Sienna",
    "last_name": "Harper",
    "email": "sienna.harper@example.com",
    "phone": "+447911123456",
    "address": "123 High Street",
    "postcode": "SW1A 1AA",
    "country": "GB"
  },
  "status": "OPEN",
  "commencement_date": "2025-08-08",
  "completion_date": "2025-08-15",
  "metadata": {
    "tour": "Alpine Cycling 7‑day",
    "duration": "7 days"
  },
  "created_at": "2025-08-08T10:00:00Z",
  "updated_at": "2025-08-08T10:00:00Z"
}
```

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

### Pricing Breakdown Schema Example

Source: https://mint-payments.readme.io/reference/getbookingbyid

An example illustrating a detailed pricing breakdown for a custom service, including base price, additional fees, and discounts.

```json
{
  "base_price": {
    "currency": "EUR",
    "value": "200.00"
  },
  "additional_fees": [
    {
      "description": "Premium service surcharge",
      "amount": {
        "currency": "EUR",
        "value": "50.00"
      }
    }
  ],
  "discounts": [
    {
      "description": "Repeat customer discount",
      "amount": {
        "currency": "EUR",
        "value": "-25.00"
      }
    }
  ]
}
```

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

### HTTP GET Request Example

Source: https://mint-payments.readme.io/reference/hpp-integration-guide-11

This example demonstrates an HTTP GET request to the HPP, where all necessary parameters are included in the URL.

```http
https://hpp-uatsb.mintpayments.net/<CompanyToken>?email=abc@xyz.com&amount=10000&reference1=REF-1234&reference2=INV-1234&redirectUrlMerchant=https://integratedposdev.mintpayments.net/hpp/confirm/beginTransaction
```

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

### Booking Customer View Link Response Example

Source: https://mint-payments.readme.io/reference/getbookingcustomerviewlink

Example of a successful response containing a customer view link for a booking.

```json
{
  "customer_view_link": "https://customer.mintpayments.com/bookings/view?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJib29raW5nX2lkIjoiQksuMDFIVlo4UU1UMzhGVjJUM1FQWTlFNyIsImN1c3RvbWVyX2lkIjoiQ1VTVC4xMjM0NTYiLCJleHAiOjE2OTI4ODMyMDB9.signature",
  "expires_at": "2025-08-13T10:00:00Z",
  "booking_reference": "REF240001",
  "has_pending_approvals": true,
  "pending_approval_count": 2,
  "message": "Please review and approve your upcoming scheduled payments"
}
```

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

### Payment Link Examples

Source: https://mint-payments.readme.io/reference/createpaymentlink

Examples of different payment link configurations.

```json
{
  "allowed_payment_methods": [
    "VISA",
    "MASTERCARD",
    "AMEX"
  ],
  "prevent_surcharging": false,
  "transaction_mode": "authorizeonly",
  "tokenize_card": true,
  "pay_by_utc": "2025-08-25T18:00:00Z",
  "metadata": {
    "link_purpose": "custom_order",
    "fulfillment_type": "made_to_order",
    "estimated_delivery": "2025-09-15",
    "note": "Funds will be captured upon order completion"
  }
}
```

```json
{
  "business_unit": "BU.06HVZ8QMT38FV2T3QPY9EC",
  "amount": "2000.00",
  "currency": "AUD",
  "customer": {
    "first_name": "Jennifer",
    "last_name": "Williams",
    "email": "jennifer.williams@example.com",
    "phone": "+61412345678"
  },
  "allowed_payment_methods": [
    "CARD",
    "PAYBYBANK"
  ],
  "prevent_surcharging": false,
  "surcharge_discount_percent": "9.09090909",
  "transaction_mode": "autocapture",
  "tokenize_card": false,
  "pay_by_utc": "2025-08-30T23:59:59Z",
  "customer_reference": "EXPORT-CUST-2025-001",
  "metadata": {
    "link_purpose": "gst_exempt_sale",
    "tax_status": "GST_EXEMPT",
    "exemption_reason": "Export sale",
    "note": "GST removed from surcharge calculation"
  }
}
```

```json
{
  "business_unit": "BU.01HVZ8QMT38FV2T3QPY9E7",
  "amount": "850.00",
  "currency": "GBP",
  "customer": {
    "first_name": "David",
    "last_name": "Brown",
    "email": "david.brown@example.com",
    "phone": "+447911444555"
  },
  "allowed_payment_methods": [
    "CARD",
    "PAYBYBANK"
  ],
  "customer_reference": "CUST-REF-2025-12345",
  "pay_by_utc": "2025-08-25T23:59:59Z",
  "metadata": {
    "link_purpose": "customer_reference_tracking",
    "internal_ref": "ORDER-789"
  }
}
```

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

### Customer Schema Example

Source: https://mint-payments.readme.io/reference/createbooking

Example structure for customer details.

```json
{
          "first_name": "Sienna",
          "last_name": "Harper",
          "email": "sienna.harper@example.com",
          "phone": "+447911123456",
          "address": "Unit 1",
          "address2": "123 High Street",
          "city": "London",
          "state": "Greater London",
          "postcode": "SW1A 1AA",
          "country": "GB"
        }
```

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

### Create a new booking

Source: https://mint-payments.readme.io/reference/createbooking

Example of creating a new booking with multi-currency support.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Mint Payments API Specification",
    "description": "OpenAPI specification for Mint's financial services platform, covering payments, banking, and financial data management.\n\n## API Categories Overview\n\nThis API provides access to multiple types of financial data and operations:\n\n### 1. Payment Links (`/payment-links/`)\nShareable payment link generation and management:\n- Dynamic payment link creation with expiration\n- Customer-facing payment collection\n- Link status tracking (active, used, expired, cancelled)\n- Customizable payment restrictions and metadata\n- Business unit-based filtering and management\n\n### 2. Payment Schedules (`/payment-schedules/`)\nAutomated payment scheduling and execution:\n- Future-dated payment execution\n- Customer approval workflows (pending approval, approved, processing)\n- Retry logic and failure handling\n- Schedule status monitoring and management\n- Flexible scheduling with customer context\n\n### 3. Mint Funds Transfers (`/funds-transfers/`)\nSpecific debits or credits **initiated by Mint** to merchant bank accounts:\n- Settlement payouts to merchants\n- Direct debits for fees or adjustments\n- Refund processing\n- All transfers controlled by Mint's payment systems\n\n### 4. Open Banking Transactions (`/open-banking/transactions/`)\nComplete transaction history pulled directly from customer bank accounts via secure banking APIs (such as AISP in the UK). This includes **all transactions** on the account:\n- Mint-related activity (payments, refunds, fees)\n- Non-Mint transactions (other merchants, transfers, direct debits, etc.)\n- Raw bank statement data with original descriptions and amounts\n\n### 5. Bank Account Management (`/bank-accounts/`)\nMaster data operations for bank account records:\n- Account creation and updates\n- IBAN, SWIFT, and routing number management\n- Business unit ownership and access control\n\n### 6. Bookings (`/bookings/`)\nTravel and service booking management:\n- Booking creation and management\n- Booking component operations\n- Integration with payment processing\n- Customer view links for booking access and payment approval\n\nThese data types serve different purposes: Payment links enable customer-initiated transactions, payment schedules handle automated future payments, Mint funds transfers track Mint's specific financial movements with merchants, while Open Banking transactions provide general merchant account visibility for reconciliation.\n",
    "version": "0.0.6",
    "contact": {
      "name": "Mint Payments Support",
      "email": "support@mintpayments.com"
    },
    "license": {
      "name": "Proprietary",
      "url": "https://mintpayments.com/license"
    }
  },
  "servers": [
    {
      "url": "https://secure.mintpayments.com/mpay/v5",
      "description": "Production server"
    },
    {
      "url": "https://secure-uatsb.mintpayments.net/mpay/v5",
      "description": "Staging server"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Bookings",
      "description": "Booking management operations for travel and service bookings"
    }
  ],
  "paths": {
    "/bookings": {
      "post": {
        "operationId": "createBooking",
        "summary": "Create a new booking",
        "description": "Create a new booking with multi-currency support",
        "tags": [
          "Bookings"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/create-booking-request"
              },
              "examples": {
                "CreateBooking": {
                  "summary": "Create a new booking",
                  "value": {
                    "business_unit": "BU.01HVZ8QMT38FV2T3QPY9E6",
                    "booking_reference": "REF240001",
                    "amount_total": "2000.00",
                    "currency": "GBP",
                    "customer": {
                      "first_name": "Sienna",
                      "last_name": "Harper",
                      "email": "sienna.harper@example.com",
                      "phone": "+447911123456"
                    },
                    "metadata": {
                      "special_requirements": "Vegetarian meals"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Booking created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "booking": {
                      "$ref": "#/components/schemas/booking"
                    }
                  }
                },
                "examples": {

```

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

### Payment Link Examples

Source: https://mint-payments.readme.io/reference/createpaymentlink

Various examples demonstrating different configurations for payment links, including customer information, payment methods, regional restrictions, and transaction modes.

```json
{
  "business_unit": "BU.01HVZ8QMT38FV2T3QPY9E7",
  "amount": "750.00",
  "currency": "GBP",
  "allowed_payment_methods": [
    "CARD"
  ],
  "tokenize_card": false,
  "pay_by_utc": "2025-08-16T12:00:00Z",
  "metadata": {
    "link_purpose": "anonymous_payment",
    "requires_customer_input": true
  }
}
```

```json
{
  "business_unit": "BU.01HVZ8QMT38FV2T3QPY9E7",
  "amount": "1200.00",
  "currency": "GBP",
  "customer": {
    "first_name": "Emma",
    "last_name": "Wilson",
    "email": "emma.wilson@example.com",
    "phone": "+447911555666"
  },
  "tokenize_card": false,
  "pay_by_utc": "2025-08-17T15:00:00Z",
  "metadata": {
    "link_purpose": "full_payment_options",
    "note": "All available payment methods enabled by default"
  }
}
```

```json
{
  "business_unit": "BU.03HVZ8QMT38FV2T3QPY9E9",
  "amount": "2500.00",
  "currency": "EUR",
  "customer": {
    "first_name": "Hans",
    "last_name": "Mueller",
    "email": "hans.mueller@example.de",
    "phone": "+49301234567"
  },
  "allowed_payment_methods": [
    "CARD",
    "PAYBYBANK"
  ],
  "allowed_regions": [
    "EEA",
    "CH",
    "NO"
  ],
  "prevent_surcharging": true,
  "transaction_mode": "authorizeonly",
  "tokenize_card": false,
  "pay_by_utc": "2025-08-18T20:00:00Z",
  "metadata": {
    "link_purpose": "european_compliance",
    "regulatory_note": "Restricted to EEA countries plus Switzerland and Norway",
    "compliance_framework": "GDPR"
  }
}
```

```json
{
  "business_unit": "BU.04HVZ8QMT38FV2T3QPY9EA",
  "amount": "99.99",
  "currency": "GBP",
  "customer": {
    "first_name": "Sarah",
    "last_name": "Johnson",
    "email": "sarah.johnson@example.com",
    "phone": "+447911777888"
  },
  "allowed_payment_methods": [
    "CARD",
    "PAYBYBANK"
  ],
  "prevent_surcharging": true,
  "transaction_mode": "autocapture",
  "tokenize_card": false,
  "pay_by_utc": "2025-08-20T23:59:59Z",
  "metadata": {
    "link_purpose": "promotional_offer",
    "campaign_id": "SUMMER2025",
    "promotion_type": "no_fees",
    "note": "Special offer - no payment fees applied"
  }
}
```

```json
{
  "business_unit": "BU.05HVZ8QMT38FV2T3QPY9EB",
  "amount": "1500.00",
  "currency": "USD",
  "customer": {
    "first_name": "Michael",
    "last_name": "Chen",
    "email": "michael.chen@example.com",
    "phone": "+1555123456"
  }
```

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

### Payment Link Response Example

Source: https://mint-payments.readme.io/reference/getpaymentlink

An example of a successful payment link response.

```json
{
  "id": "PL.9x8AVs72UhLTR6oZlMyCAo",
  "business_unit": "BU.01HVZ8QMT38FV2T3QPY9E7",
  "url": "https://pay.mintpayments.com/pl/2398weruwiouersdkfiejewr",
  "virtual_terminal_url": "https://pay.mintpayments.com/pl/2398weruwiouersdkfiejewr/vt/V2eT3byQP",
  "status": "OPEN",
  "amount": "1000.00",
  "currency": "GBP",
  "customer": {
    "first_name": "Sienna",
    "last_name": "Harper",
    "email": "sienna.harper@example.com",
    "phone": "+447911123456",
    "address": "Unit 1",
    "address2": "123 High Street",
    "city": "London",
    "state": "Greater London",
    "postcode": "SW1A 1AA",
    "country": "GB"
  },
  "allowed_payment_methods": [
    "CARD",
    "PAYBYBANK"
  ],
  "booking": "BK.01HVZ8QMT38FV2T3QPY9E7J2Z8",
  "redirect_url": "https://example.com/booking/confirmation",
  "redirect_target": "_self",
  "prevent_surcharging": false,
  "surcharge_discount_percent": "9.09090909",
  "transaction_mode": "autocapture",
  "tokenize_card": false,
  "pay_by_utc": "2025-08-15T23:59:59Z",
  "description": "Payment for premium subscription",
  "customer_reference": "CUST-REF-12345",
  "invoice_number": "INV-2025-001",
  "allowed_regions": [
    "DOMESTIC",
    "EEA"
  ],
  "overridable_fields": [
    "customer.first_name",
    "customer.last_name",
    "customer.phone"
  ],
  "metadata": {
    "link_purpose": "deposit_payment",
    "expires_in_hours": 168
  },
  "created_at": "2025-08-12T10:00:00Z",
  "updated_at": "2025-08-12T10:00:00Z"
}
```

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

### BookingCreated Response Example

Source: https://mint-payments.readme.io/reference/createbooking

Example of a successful booking creation response.

```json
{
                  "BookingCreated": {
                    "summary": "Successfully created booking",
                    "value": {
                      "booking": {
                        "id": "BK.01HVZ8QMT38FV2T3QPY9E7",
                        "business_unit": "BU.01HVZ8QMT38FV2T3QPY9E6",
                        "booking_reference": "REF240001",
                        "amount_total": {
                          "currency": "GBP",
                          "value": "2000.00"
                        },
                        "customer": {
                          "first_name": "Sienna",
                          "last_name": "Harper",
                          "email": "sienna.harper@example.com",
                          "phone": "+447911123456"
                        },
                        "status": "OPEN",
                        "components": [],
                        "payments": [],
                        "payment_links": [],
                        "scheduled_payments": [],
                        "metadata": {
                          "special_requirements": "Vegetarian meals"
                        },
                        "created_at": "2025-08-08T10:00:00Z",
                        "updated_at": "2025-08-08T10:00:00Z"
                      }
                    }
                  }
                }
```

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

### Currency Parameters Example

Source: https://mint-payments.readme.io/reference/mint-webhook-integration-guide

An example showing currency parameters, including the charged currency and its ISO code.

```json
{
  "36-1": "Currency customer was charged in if customer elected to pay in own currency",
  "36-2": "EUR",
  "36-3": "ISO 4217 currency code. Nullable"
},
"cols": 4,
"rows": 37,
"align": [
  null,
  null,
  null,
  null
]
```

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

### Transaction Example

Source: https://mint-payments.readme.io/reference/getfundstransferitems

An example of a transaction object as defined by the OpenAPI schema.

```json
{
  "transaction_id": "TXN.7n42DGM5Tflk9n8mt7Fhc7",
  "created_at": "2025-08-12T10:15:30Z",
  "status": "APPROVED",
  "transaction_type": "purchase",
  "response_code": "00",
  "response_message": "Transaction Approved",
  "purchase_reference": "REF240001-001",
  "amount": "1000.00",
  "surcharge_amount": "25.00",
  "total_amount": "1025.00",
  "captured": true,
  "currency": "GBP",
  "business_unit": "BU.17HZ4MFeqHBoboEW8IlZbB",
  "customer": {
    "first_name": "Sienna",
    "last_name": "Harper",
    "email": "sienna.harper@example.com",
    "phone": "+447911123456",
    "address": "123 High Street",
    "postcode": "SW1A 1AA",
    "country": "GB"
  },
  "booking": "BK.9p64FIO7Vhmq1r0ov9Hje9",
  "paylink": null,
  "scheduled_payment": null
}
```

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

### Accommodation Component Created Example

Source: https://mint-payments.readme.io/reference/createbookingcomponent

Example of a successfully created accommodation booking component.

```json
{
  "component": {
    "id": "BC.01HVZ8QMT38FV2T3QPY9E7J2ZA",
    "type": "accommodation",
    "name": "Hotel Roma Palace",
    "description": "5-star luxury hotel in central Rome with spa facilities",
    "amount": {
      "currency": "EUR",
      "value": "1200.00"
    },
    "supplier_reference": "ROMA-HTL-001",
    "agent_reference": "AG-ROME-2025-001",
    "city": "Rome",
    "country": "IT",
    "check_in_date": "2025-09-15",
    "check_out_date": "2025-09-18",
    "guest_count": 2,
    "address": {
      "street": "Via del Corso 123",
      "postal_code": "00186",
      "region": "Lazio"
    },
    "metadata": {
      "booking_notes": "Anniversary celebration",
      "preferred_floor": "high"
    },
    "created_at": "2025-08-08T10:00:00Z",
    "updated_at": "2025-08-08T10:00:00Z"
  }
}
```

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

### Purchase Retrieval Response Example

Source: https://mint-payments.readme.io/reference/getpurchase

An example of a successful purchase retrieval response.

```json
{
  "transaction_time_utc": "2025-08-12T16:30:00Z",
  "status": "APPROVED",
  "amount": 100.5,
  "authorised_amount": 110.5,
  "currency": "AUD",
  "response_code": "success",
  "response_message": "Transaction Approved"
}
```

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

### Forbidden Response Example

Source: https://mint-payments.readme.io/reference/getfundstransferitems

Example of a forbidden response, indicating insufficient permissions.

```json
{
  "code": 403,
  "message": "Forbidden",
  "details": "Insufficient permissions"
}
```

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

### Payment Schedule Response Example

Source: https://mint-payments.readme.io/reference/createpaymentschedule

An example of a successful response when creating or retrieving a payment schedule.

```json
{
  "id": "PS.01HVZ8QMT38FV2T3QPY9E7J2",
  "business_unit": "BU.01HVZ8QMT38FV2T3QPY9E7",
  "amount": "1000.00",
  "currency": "GBP",
  "schedule_type": "single",
  "booking": "BK.01HVZ8QMT38FV2T3QPY9E7",
  "card_token": "tok_1234567890abcdef1234567890abcdef",
  "execute_after": "2025-08-15T10:00:00Z",
  "requires_customer_approval": false,
  "status": "COMPLETED",
  "created_at": "2025-08-07T10:00:00Z",
  "updated_at": "2025-08-15T10:05:00Z"
}
```

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

### Example Payment Link Object

Source: https://mint-payments.readme.io/reference/getpaymentlink

An example of a payment link object as defined by the OpenAPI specification.

```json
{
  "id": "PL.2398weruwiouersdkfiejewr",
  "business_unit": "BU.01HVZ8QMT38FV2T3QPY9E7",
  "url": "https://pay.mintpayments.com/pl/2398weruwiouersdkfiejewr",
  "virtual_terminal_url": "https://pay.mintpayments.com/pl/2398weruwiouersdkfiejewr/vt/V2eT3byQP",
  "status": "OPEN",
  "amount": "2500.00",
  "currency": "GBP",
  "customer": {
    "first_name": "Sienna",
    "last_name": "Harper",
    "email": "sienna.harper@example.com",
    "phone": "+447911123456",
    "address": "123 High Street",
    "postcode": "SW1A 1AA",
    "country": "GB"
  },
  "allowed_payment_methods": {
    "type": "CARD",
    "brands": ["VISA", "MC"]
  },
  "booking": "BK.9p64FIO7Vhmq1r0ov9Hje9",
  "created_at": "2025-08-08T10:00:00Z",
  "updated_at": "2025-08-08T10:00:00Z"
}
```

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

### Sample Request

Source: https://mint-payments.readme.io/reference/restful-api-reference

Example JSON request body for capturing a pre-authorised purchase.

```json
{
    "token": {
      "company_token": "DYu1j58asxIc380N6EHY1nyqN3oSyc1",
      "transaction_token": "1f41ec36-4603-48a8-ba4d-e1a770faaceb"
    },
    "capture": {
        "amount":100.50,
        "currency":AUD,
        "should_mint_apply_surcharge": false
    },
    "metadata": {
        "channel": "API"
        "merchant_hash": "qnR8DKqJggD55PohusdffaBNviGoOJ67HC6Btry4qKSKJDZc="

    }
}
        
```

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

### Successful Card Details Retrieval Example

Source: https://mint-payments.readme.io/reference/getcarddetails

An example of a successful response when retrieving card details.

```json
{
  "card_token": "ab123456-abc4-123a-ab12-a12bb34c5def",
  "multi_use": true,
  "created_timestamp_utc": "2020-03-26 02:08:38 AM",
  "card": {
    "number": "424242******4242",
    "expiry_month": "02",
    "expiry_year": "22",
    "holder_name": "John Doe",
    "funding": "credit",
    "country": "US",
    "brand": "visa"
  },
  "customer": {
    "id": "bc234567-bcd5-234b-bc23-b23cc45d6efg"
  }
}
```

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

### Get Transaction By ID OpenAPI Definition

Source: https://mint-payments.readme.io/reference/gettransactionbyid

This snippet shows the OpenAPI definition for the 'Get transaction by ID' endpoint, including parameters, responses, and an example response payload.

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "MintEFT API Specification",
    "description": "REST API for creating, authorising, searching, and tracking MintEFT transactions.\n\nChangelog\n- 2026-04-08 : Added optional `transaction.booking` object for create and response payloads.\n  Added optional booking properties: `booking_reference`, `passenger_reference`, `commencement_date`, `completion_date`.\n- 2026-04-10 : Added optional `destination` to `transaction.booking` for create and transaction retrieval payloads.",
    "version": "1.0.0",
    "license": {
      "name": "Proprietary"
    },
    "contact": {
      "name": "MintEFT Support",
      "email": "support@mintpayments.com"
    }
  },
  "servers": [
    {
      "url": "https://secure-uatsb.mintpayments.net/eft/v1",
      "description": "Sandbox"
    },
    {
      "url": "https://secure.mintpayments.com/eft/v1",
      "description": "Production"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Transactions",
      "description": "Create, authorise, cancel, and query transactions and payees."
    }
  ],
  "paths": {
    "/transaction-by-id/{transaction_id}": {
      "get": {
        "tags": [
          "Transactions"
        ],
        "summary": "Get transaction by ID",
        "description": "Retrieve a single transaction by its MintEFT transaction ID.",
        "operationId": "getTransactionById",
        "parameters": [
          {
            "name": "transaction_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "example": "276951089115830657"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Transaction details",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TransactionDetail"
                },
                "example": {
                  "transaction": {
                    "requested_by_email": "api.user@mintpayments.com",
                    "requested_by_name": "API User",
                    "from_company": "Mint Payments Test Payer",
                    "from_company_number": "M798240",
                    "to_company": "Mint Payments Test Payee",
                    "to_company_number": "M369164",
                    "transaction_id": "276951089115830657",
                    "passenger_name": "Nick",
                    "booking": {
                      "booking_reference": "BK-2026-0001",
                      "passenger_reference": "PAX-44521",
                      "destination": "Sydney",
                      "commencement_date": "2026-03-15",
                      "completion_date": "2026-03-22"
                    },
                    "amount": 200.2,
                    "currency": "AUD",
                    "type": "create_payment",
                    "created_at": "2026-03-01T09:10:00Z",
                    "updated_at": "2026-03-01T09:12:20Z",
                    "authorised_at": "2026-03-01T09:12:00Z",
                    "due_at": "2026-03-08T00:00:00Z",
                    "status": "authorised",
                    "invoice_number": "testinvoice",
                    "transaction_reference": "testpayment",
                    "bank_reference": "778891",
                    "notes": "testing",
                    "parent_transaction": ""
                  },
                  "response_code": "00",
                  "response_message": "Successful"
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Bearer access token (opaque token, not JWT)"
      }
    },
    "responses": {
      "NotFound": {
        "description": "Not found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      }
    },
    "schemas": {
      "TransactionData": {
        "type": "object",
        "properties": {
          "requested_by_email": {
            "type": "string",
            "description": "Requested user email"
          },
          "requested_by_name": {
            "type": "string",
            "description": "Requested user name"
          },
          "from_company": {
            "type": "string",
            "description": "Payer Company"
          },
          "from_company_number": {
            "type": "string",
            "description": "Payer Company Number"
          },
          "to_company": {
            "type": "string",
            "description": "Payee Company Name"
          },
          "to_company_number": {
            "type": "string",
            "description": "Payee Company Number"
          },
          "transaction_id": {
            "type": "string",
            "description": "MintEFT Transaction ID"
          },
          "passenger_name": {
            "type": "string",
            "description": "Passenger Name"
          },
          "booking": {
            "type": "object",
            "properties": {
              "booking_reference": {
                "type": "string",
                "description": "Booking Reference"
              },
              "passenger_reference": {
                "type": "string",
                "description": "Passenger Reference"
              },
              "destination": {
                "type": "string",
                "description": "Destination"
              },
              "commencement_date": {
                "type": "string",
                "format": "date",
                "description": "Commencement Date"
              },
              "completion_date": {
                "type": "string",
                "format": "date",
                "description": "Completion Date"
              }
            }
          },
          "amount": {
            "type": "number",
            "description": "Transaction Amount"
          },
          "currency": {
            "type": "string",
            "description": "Currency Code (e.g. AUD)"
          },
          "type": {
            "type": "string",
            "description": "Transaction Type (e.g. create_payment)"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp of when the transaction was created"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp of when the transaction was last updated"
          },
          "authorised_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp of when the transaction was authorised"
          },
          "due_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp of when the transaction is due"
          },
          "status": {
            "type": "string",
            "description": "Transaction Status (e.g. authorised)"
          },
          "invoice_number": {
            "type": "string",
            "description": "Invoice Number"
          },
          "transaction_reference": {
            "type": "string",
            "description": "Transaction Reference"
          },
          "bank_reference": {
            "type": "string",
            "description": "Bank Reference"
          },
          "notes": {
            "type": "string",
            "description": "Notes"
          },
          "parent_transaction": {
            "type": "string",
            "description": "Parent Transaction ID"
          }
        }
      },
      "TransactionDetail": {
        "type": "object",
        "properties": {
          "transaction": {
            "$ref": "#/components/schemas/TransactionData"
          },
          "response_code": {
            "type": "string",
            "description": "Response Code"
          },
          "response_message": {
            "type": "string",
            "description": "Response Message"
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "Error message"
          }
        }
      }
    }
  }
}
```

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

### Flight Component Created Example

Source: https://mint-payments.readme.io/reference/createbookingcomponent

Example of a successfully created flight booking component.

```json
{
  "component": {
    "id": "BC.01HVZ8QMT38FV2T3QPY9E7J2ZB",
    "type": "flight",
    "name": "London to Rome",
    "description": "Direct flight from Heathrow to Fiumicino",
    "amount": {
      "currency": "GBP",
      "value": "450.00"
    },
    "supplier_reference": "BA-555-15SEP25",
    "agent_reference": "AG-FLIGHT-2025-001",
    "departure_airport": "LHR",
    "arrival_airport": "FCO",
    "departure_date_time": "2025-09-15T08:30:00Z",
    "arrival_date_time": "2025-09-15T12:45:00Z",
    "flight_number": "BA555",
    "airline_code": "BA",
    "passenger_count": 2,
    "metadata": {
      "pnr": "ABC123",
      "ticket_numbers": [
        "1234567890123",
        "1234567890124"
      ]
    },
    "created_at": "2025-08-08T10:00:00Z",
    "updated_at": "2025-08-08T10:00:00Z"
  }
}
```

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

### Response Example

Source: https://mint-payments.readme.io/reference/createbankaccountaccessconsent

Example of a successful Bank Account Access Consent creation response.

```json
{
  "bank_account_access_consent": {
    "bank_account_access_consent": "BAAC.7n42DGM5Tflk9n8mt7Fhc7",
    "business_unit": "BU.17HZ4MFeqHBoboEW8IlZbB",
    "status": "pending",
    "authorisation_uri": "https://auth.bank.com/consent/authorize?consent=BAAC.7n42DGM5Tflk9n8mt7Fhc7",
    "return_uri": "https://myapp.com/account/connected"
  }
}
```

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

### Error Response Example (404 Not Found)

Source: https://mint-payments.readme.io/reference/getpaymentschedule

Example of a not found error response when the requested payment schedule does not exist.

```json
{
  "code": 404,
  "message": "Not Found",
  "details": "Payment schedule not found",
  "timestamp": "2025-08-12T08:29:51.162Z",
  "path": "/payment-schedules/PS.01HVZ8QMT38FV2T3QPY9E7",
  "trace_id": "trace_01HVZ8QMT38FV2T3QPY9E7J313"
}
```

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

### Redirect Overridable Link Example

Source: https://mint-payments.readme.io/reference/createpaymentlink

Example of a payment link with overridable redirect settings.

```json
{
  "business_unit": "BU.01HVZ8QMT38FV2T3QPY9E7",
  "amount": "300.00",
  "currency": "GBP",
  "customer": {
    "first_name": "Sarah",
    "last_name": "Wilson",
    "email": "sarah.wilson@example.com",
    "phone": "+447911999000"
  },
  "allowed_payment_methods": [
    "CARD"
  ],
  "redirect_url": "https://example.com/default/success",
  "redirect_target": "_self",
  "overridable_fields": [
    "customer.first_name",
    "customer.last_name"
  ],
  "pay_by_utc": "2025-08-22T23:59:59Z",
  "metadata": {

```

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

### Customer View Link Example

Source: https://mint-payments.readme.io/reference/getbookingcustomerviewlink

Example of a customer view link object returned by the API.

```json
{
          "customer_view_link": "https://customer.mintpayments.com/bookings/view?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJib29raW5nX2lkIjoiQksuMDFIVlo4UU1UMzhGVjJUM1FQWTlFNyIsImN1c3RvbWVyX2lkIjoiQ1VTVC4xMjM0NTYiLCJleHAiOjE2OTI4ODMyMDB9.signature",
          "expires_at": "2025-08-13T10:00:00Z",
          "booking_reference": "REF240001",
          "has_pending_approvals": true,
          "pending_approval_count": 2,
          "message": "Please review and approve your upcoming scheduled payments for your booking"
        }
```

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

### Payment Schedule Response Examples

Source: https://mint-payments.readme.io/reference/createpaymentschedule

Examples of a successful payment schedule response, one standard and one requiring customer approval.

```json
{
  "payment_schedule": {
    "id": "PS.01HVZ8QMT38FV2T3QPY9E7",
    "business_unit": "BU.01HVZ8QMT38FV2T3QPY9E7",
    "amount": "1000.00",
    "currency": "GBP",
    "schedule_type": "single",
    "booking": "BK.01HVZ8QMT38FV2T3QPY9E7",
    "card_token": "tok_1234567890abcdef1234567890abcdef",
    "execute_after": "2025-08-15T10:00:00Z",
    "requires_customer_approval": false,
    "status": "PENDING",
    "created_at": "2025-08-12T08:29:51.162Z",
    "updated_at": "2025-08-12T08:29:51.162Z"
  }
}
```

```json
{
  "payment_schedule": {
    "id": "PS.02HVZ8QMT38FV2T3QPY9E8",
    "business_unit": "BU.01HVZ8QMT38FV2T3QPY9E7",
    "amount": "2500.00",
    "currency": "GBP",
    "schedule_type": "single",
    "booking": "BK.02HVZ8QMT38FV2T3QPY9E8",
    "card_token": "tok_abcdef1234567890abcdef1234567890",
    "execute_after": "2025-08-20T14:00:00Z",
    "requires_customer_approval": true,
    "status": "PENDING_APPROVAL",
    "created_at": "2025-08-12T08:29:51.162Z",
    "updated_at": "2025-08-12T08:29:51.162Z"
  }
}
```

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

### cURL Request Example

Source: https://mint-payments.readme.io/reference/payment-schedules-1

Example of a POST request to create a payment schedule using cURL.

```shell
curl --request POST \
     --url https://secure.mintpayments.com/mpay/v5/payment-schedules \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "schedule_type": "single"
}
'
```

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

### Booking Details Schema Example

Source: https://mint-payments.readme.io/reference/getbookingbyid

An example of a booking object conforming to the OpenAPI schema, detailing a personal shopping experience.

```json
{
  "id": "BC.01HVZ8QMT38FV2T3QPY9E7J2ZG",
  "type": "custom",
  "name": "Personal Shopping Experience",
  "description": "Exclusive personal shopping service with luxury brand access",
  "amount": {
    "currency": "EUR",
    "value": "225.00"
  },
  "supplier_reference": "ECS-SHOP-001",
  "agent_reference": "AG-CUSTOM-2025-001",
  "service_category": "concierge_service",
  "service_provider": "Elite Concierge Services",
  "service_date": "2025-09-16",
  "service_time": "10:00:00Z",
  "participant_count": 2,
  "service_details": {
    "inclusions": [
      "Personal shopping assistant",
      "VIP access",
      "Transportation",
      "Gift wrapping"
    ],
    "exclusions": [
    ]
  },
  "terms_and_conditions": "Service must be cancelled 48 hours in advance for full refund. Weather-dependent services may be rescheduled.",
  "custom_fields": {
    "priority_level": "VIP",
    "internal_notes": "Customer prefers morning appointments",
    "billing_code": "CONC-001",
    "department": "Luxury Services"
  }
}
```

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

### Sample Request

Source: https://mint-payments.readme.io/reference/restful-api-reference

Example JSON request body for creating a card token.

```json
{
        "card":
        {
            "number": "4000002760003184",
            "expiry_month": "02",
            "expiry_year": "24",
            "cvc": "123",
            "holder_name": "John Doe"
        },
        "customer":
        {
            "store_card_permisison":"987654321",
            "id": "dc95a92c-46ac-44b0-b3ba-3a783ec3fd62",

        },
        "company_token": "DYu1j58asxIc380N6EHY1nyqN3oSyc1"
}
```
Tokens:
Raw