{
  "opencollection": "1.0.0",
  "info": {
    "name": "Modulr API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Card Simulator",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Reverse a credit authorisation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/credit-authorisations/:creditAuthId/reverse",
            "params": [
              {
                "name": "creditAuthId",
                "value": "X000000001",
                "type": "path",
                "description": "ID of the CREDIT_AUTH activity to reverse"
              }
            ]
          },
          "docs": "Reverse a pending credit authorisation, producing a CREDIT_AUTH_REV activity"
        },
        {
          "info": {
            "name": "Create a settlement without prior authorisation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/settlements",
            "params": [
              {
                "name": "cardId",
                "value": "V000000001",
                "type": "path",
                "description": "Card ID to settle against"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Submit a settlement directly to the reconciliation pipeline without a prior authorisation"
        },
        {
          "info": {
            "name": "Create a card refund",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/refunds",
            "params": [
              {
                "name": "cardId",
                "value": "V000000001",
                "type": "path",
                "description": "Card id to be refund"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Simulate a standalone refund (credit) for a card, producing a REFUND activity"
        },
        {
          "info": {
            "name": "Simulate an original credit",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/original-credits",
            "params": [
              {
                "name": "cardId",
                "value": "V000000001",
                "type": "path",
                "description": "Card ID to credit"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Submit card activity of type original credit"
        },
        {
          "info": {
            "name": "Reverse an original credit",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/original-credits/:originalCreditActivityId/reverse",
            "params": [
              {
                "name": "cardId",
                "value": "V000000001",
                "type": "path",
                "description": "Card ID"
              },
              {
                "name": "originalCreditActivityId",
                "value": "X000000001",
                "type": "path",
                "description": "ID of the ORIGINAL_CREDIT activity to reverse"
              }
            ]
          },
          "docs": "Reverse a previously applied original credit, producing an ORIGINAL_CREDIT_REVERSAL activity"
        },
        {
          "info": {
            "name": "Create an offline transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/offline-transactions",
            "params": [
              {
                "name": "cardId",
                "value": "V000000001",
                "type": "path",
                "description": "Card ID to create an offline transaction for"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Simulate an offline transaction for a card"
        },
        {
          "info": {
            "name": "Simulate a card expiry",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/expire",
            "params": [
              {
                "name": "cardId",
                "value": "V000000001",
                "type": "path",
                "description": "Card ID to expire"
              }
            ]
          },
          "docs": "Simulate the GPS CARD_EXPIRY message, transitioning the card status to EXPIRED in card-service"
        },
        {
          "info": {
            "name": "Simulate a credit authorisation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/credit-authorisations",
            "params": [
              {
                "name": "cardId",
                "value": "V000000001",
                "type": "path",
                "description": "Card ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Submit card activity of type credit authorisation"
        },
        {
          "info": {
            "name": "Create a standalone chargeback",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/chargebacks",
            "params": [
              {
                "name": "cardId",
                "value": "V000000001",
                "type": "path",
                "description": "Card id to chargeback"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Simulate a standalone chargeback for a card."
        },
        {
          "info": {
            "name": "Create a card authorisation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/authorisations",
            "params": [
              {
                "name": "cardId",
                "value": "V000000001",
                "type": "path",
                "description": "Card ID to create an authorisation for this card"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an authorisation for a card"
        },
        {
          "info": {
            "name": "Chargeback an existing settlement",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/activities/:settlementActivityId/chargebacks",
            "params": [
              {
                "name": "cardId",
                "value": "V000000001",
                "type": "path",
                "description": "Card id"
              },
              {
                "name": "settlementActivityId",
                "value": "X000000001",
                "type": "path",
                "description": "Settlement activity BID to chargeback"
              }
            ]
          },
          "docs": "Simulate a chargeback of an existing settlement activity."
        },
        {
          "info": {
            "name": "Perform an account status inquiry",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/account-status-inquiry",
            "params": [
              {
                "name": "cardId",
                "value": "V000000001",
                "type": "path",
                "description": "Card ID to perform the account status inquiry against"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Check whether a card is eligible for transactions without reserving funds"
        },
        {
          "info": {
            "name": "Unbind a device from a card token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/card-tokens/:tokenId/devices/:deviceId/unbind",
            "params": [
              {
                "name": "tokenId",
                "value": "T110000001",
                "type": "path",
                "description": "Card token ID"
              },
              {
                "name": "deviceId",
                "value": "D110000001",
                "type": "path",
                "description": "Device ID to unbind"
              },
              {
                "name": "cardId",
                "value": "V110000001",
                "type": "query",
                "description": "Card ID that owns the token"
              }
            ]
          },
          "docs": "Simulate the removal of a device binding from a card token, marking the device as DELETED within the token record in card-service"
        },
        {
          "info": {
            "name": "Settle the full or partial card authorisation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/authorisations/:authId/settle",
            "params": [
              {
                "name": "authId",
                "value": "A00000000X",
                "type": "path",
                "description": "Card authorisation id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Settle the full card authorisation or supply an optional settlementAmount for partial settlement."
        },
        {
          "info": {
            "name": "Reverse the card authorisation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/authorisations/:authId/reverse",
            "params": [
              {
                "name": "authId",
                "value": "A00000000X",
                "type": "path",
                "description": "Card authorisation id to be reversed"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Simulate a reversal of an authorization for a card"
        },
        {
          "info": {
            "name": "Resettlement of a chargeback",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/activities/:chargebackActivityId/resettlement",
            "params": [
              {
                "name": "chargebackActivityId",
                "value": "X000000001",
                "type": "path",
                "description": "ID of the CHARGEBACK activity to resettle"
              }
            ]
          },
          "docs": "Simulate a resettlement (second presentment) for an existing CHARGEBACK activity, producing a RESETTLEMENT activity."
        },
        {
          "info": {
            "name": "Reverse a chargeback",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/activities/:chargebackActivityId/chargeback-reversal",
            "params": [
              {
                "name": "chargebackActivityId",
                "value": "X000000001",
                "type": "path",
                "description": "ID of the CHARGEBACK activity to reverse"
              }
            ]
          },
          "docs": "Simulate a chargeback reversal for an existing CHARGEBACK activity, producing a CHARGEBACK_REVERSAL activity."
        }
      ]
    },
    {
      "info": {
        "name": "Customers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a specific customer using a unique customer reference",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of customer to fetch"
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query",
                "description": "Customer statuses allowed when fetching the customer"
              }
            ]
          },
          "docs": "Retrieve a specific customer using a unique customer reference. This identifier can be found in the response obtained after creating a new customer, it starts by C, e.g: C0000000"
        },
        {
          "info": {
            "name": "Edit a specific customer using a unique customer reference",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId",
            "params": [
              {
                "name": "customerId",
                "value": "C0000000",
                "type": "path",
                "description": "ID of customer to be edited"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "  Currently editable fields:\n  <ol>\n    <li>For all customer types: <b>externalReference</b> can be edited</li>\n    <li>For all customers not requiring manual or in-house KYC verification: <b>industryCode</b>, <b>registeredAddress</b>, <b>tcsVersions</b> and <b>regNumber</b> can additionally be edited. Of those:\n      <ul>\n        <li>For all other customer types: <b>name</b> and <b>tradingAddress</b> can additionally be edited</li>\n        <li>For all types other than PCM_BUSINESS: the <b>assoc"
        },
        {
          "info": {
            "name": "Edit a customer",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Edit details of a particular customer using its ID as a reference. Current editable fields: complianceData"
        },
        {
          "info": {
            "name": "Retrieve customers using filters",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "ID of Customer(s) to fetch"
              },
              {
                "name": "delegateId",
                "value": "",
                "type": "query"
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "Query parameter. ID, name or external reference of customer to search for"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Type to filter, can be one of:\n1. LLC -> limited company\n2. PLC -> publicly listed company\n3. SOLETRADER -> sole trader\n4. OPARTNRSHP -> ordinary partnership\n5. LPARTNRSHP -> limited partnership\n6. LLP -> limited liability partnership\n7. INDIVIDUAL -> individual consumer\n8. PCM_INDIVIDUAL -> partner clearing model individual consumer\n9. PCM_BUSINESS -> partner clearing model business consumer"
              },
              {
                "name": "verificationStatus",
                "value": "",
                "type": "query",
                "description": "Verification Status to filter, can be one of:\n1. UNVERIFIED -> no verification checks have been completed\n2. VERIFIED -> verification checks completed satisfactorily\n3. EXVERIFIED -> verification completed externally\n4. REFERRED -> verification is pending manual review\n5. DECLINED -> verification is complete with a negative result\n6. REVIEWED -> verification check has been reviewed"
              },
              {
                "name": "fromCreatedDate",
                "value": "",
                "type": "query",
                "description": "Customers created after and on this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000"
              },
              {
                "name": "toCreatedDate",
                "value": "",
                "type": "query",
                "description": "Customers created before and on this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of Page to fetch"
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query",
                "description": "Sort by field. Sorted by createdDate if not present"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sorting order:\n1. asc -> ascendant\n2. desc -> descendant"
              },
              {
                "name": "externalRef",
                "value": "",
                "type": "query",
                "description": "A list of external references to filter"
              },
              {
                "name": "externalReference",
                "value": "externalReference[0].type",
                "type": "query",
                "description": "A list of external references to filter"
              },
              {
                "name": "name.type",
                "value": "",
                "type": "query",
                "description": "WORD_MATCH - using word boundaries,\nWORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,\nPREFIX - same case prefix,\nSUFFIX - same case suffix,\nCONTAINS - same case contains\nEXACT - same case exact\n"
              },
              {
                "name": "name.value",
                "value": "",
                "type": "query"
              },
              {
                "name": "companyRegNumber",
                "value": "",
                "type": "query",
                "description": "Customer registration number"
              },
              {
                "name": "legalEntity",
                "value": "",
                "type": "query",
                "description": "Customer legal entity"
              },
              {
                "name": "contractCounterparty",
                "value": "",
                "type": "query",
                "description": "The Modulr business unit with which the customer has contracted"
              },
              {
                "name": "addressLines",
                "value": "",
                "type": "query",
                "description": "Set of the address lines. If specified, they must be present in the address line 1 or in the address line 2.\nSearch results by number may include numbers with any suffix"
              },
              {
                "name": "postCode",
                "value": "",
                "type": "query"
              },
              {
                "name": "postTown",
                "value": "",
                "type": "query"
              },
              {
                "name": "country",
                "value": "",
                "type": "query"
              },
              {
                "name": "associateSearchCriteria.firstNameInitial",
                "value": "",
                "type": "query",
                "description": "Person's first name initial"
              },
              {
                "name": "associateSearchCriteria.lastName.type",
                "value": "",
                "type": "query",
                "description": "WORD_MATCH - using word boundaries,\nWORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,\nPREFIX - same case prefix,\nSUFFIX - same case suffix,\nCONTAINS - same case contains\nEXACT - same case exact\n"
              },
              {
                "name": "associateSearchCriteria.lastName.value",
                "value": "",
                "type": "query"
              },
              {
                "name": "associateSearchCriteria.lastNamePrefix",
                "value": "",
                "type": "query",
                "description": "Person's prefix"
              },
              {
                "name": "associateSearchCriteria.dateOfBirth",
                "value": "",
                "type": "query",
                "description": "Person's date of birth "
              },
              {
                "name": "associateSearchCriteria.additionalIdentifier.type",
                "value": "",
                "type": "query",
                "description": "Type of additional personal identifier"
              },
              {
                "name": "associateSearchCriteria.additionalIdentifier.value",
                "value": "",
                "type": "query",
                "description": "Personal identifier value"
              },
              {
                "name": "associateTypes",
                "value": "",
                "type": "query",
                "description": "List of types to filter, can be one of:\n1. DIRECTOR -> director\n2. PARTNER -> partner\n3. CSECRETARY -> company secretary\n4. SOLETRADER -> sole trader\n5. BENE_OWNER -> beneficial owner\n6. C_INTEREST -> controlling interest\n7. INDIVIDUAL -> individual\n8. PCM_INDIVIDUAL -> pcm individual\n9. SIGNATORY -> signatory\n9. TRUST_SETTLOR -> trust settlor\n9. TRUST_BENEFICIARY -> trust beneficiary\n10. TRUST_TRUSTEE -> trust trustee"
              }
            ]
          },
          "docs": "Either using unique references, such as customer ID, or filter parameters, such as verification status, get details of any customers found."
        },
        {
          "info": {
            "name": "Create a new customer",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows you to create a new customer. Creating a customer is a complex process with several dependencies, e.g: Directors, type of customer, legal specifications. For further information, please visit 'Creating a customer and account' entry on our API documentation"
        },
        {
          "info": {
            "name": "Create a secure Customer Verification SDK Session",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/keys/applications/:applicationId",
            "params": [
              {
                "name": "applicationId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Creates a short-lived access key that authorises a Customer Verification session for the specified application."
        },
        {
          "info": {
            "name": "Create a New Onboarding Application",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/applications",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new application with a unique identifier with a status of NEW."
        },
        {
          "info": {
            "name": "Submit an application for verification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/applications/:applicationId/verify",
            "params": [
              {
                "name": "applicationId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Submits an application for initial KYB/KYC review once all required data is provided."
        },
        {
          "info": {
            "name": "Submit a business application for verification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/applications/:applicationId/submissions",
            "params": [
              {
                "name": "applicationId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Initiates KYB verification for a business application and returns a submission reference."
        },
        {
          "info": {
            "name": "Mark application as closed for modification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/applications/:applicationId/finalisations",
            "params": [
              {
                "name": "applicationId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Confirms all business and associate details have been submitted. The application will be processed for verification."
        },
        {
          "info": {
            "name": "Submit an associate for verification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/applications/:applicationId/associates/:associateId/submissions",
            "params": [
              {
                "name": "applicationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "associateId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Submits an associate for KYB verification and returns a submission reference."
        },
        {
          "info": {
            "name": "Create or update a customer’s tax identifiers",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/compliance/tax-identifiers",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of customer"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates or updates a customer’s tax identifiers, please provide list of countries where applicable"
        },
        {
          "info": {
            "name": "Create or update customer identification information",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/compliance/identification-info",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of customer"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates or updates customer identification information, such as national or legal entity identifiers"
        },
        {
          "info": {
            "name": "Create or update the list of countries where an associate is considered tax-resident",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/compliance/associates/:associateId/tax-residencies",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of customer"
              },
              {
                "name": "associateId",
                "value": "",
                "type": "path",
                "description": "ID of associate"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates or updates the list of countries where an associate is considered tax-resident, supporting compliance with CRS/FATCA and local tax rules"
        },
        {
          "info": {
            "name": "Create or update tax identifiers for an associate",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/compliance/associates/:associateId/tax-identifiers",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of customer"
              },
              {
                "name": "associateId",
                "value": "",
                "type": "path",
                "description": "ID of associate"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates or updates an associate’s tax identifiers, specific types are available for Spain, France and Netherlands, use type TIN for all other country codes"
        },
        {
          "info": {
            "name": "Create or update an associate’s personal details",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/compliance/associates/:associateId/personal-info",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of customer"
              },
              {
                "name": "associateId",
                "value": "",
                "type": "path",
                "description": "ID of associate"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates or updates an associate’s personal details, such as birth data, nationality, and sex"
        },
        {
          "info": {
            "name": "Create or update the department code for an associate",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/compliance/associates/:associateId/fr/department",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of customer"
              },
              {
                "name": "associateId",
                "value": "",
                "type": "path",
                "description": "ID of associate"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates or updates the department code for individuals residing in France"
        },
        {
          "info": {
            "name": "Create or update identification document details for an associate",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/compliance/associates/:associateId/document-details",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of customer"
              },
              {
                "name": "associateId",
                "value": "",
                "type": "path",
                "description": "ID of associate"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates or updates identification document details for an associate. Captures official document data used for verification and compliance checks"
        },
        {
          "info": {
            "name": "Create or Update Know Your Customer Data for a Customer Application",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/applications/:applicationId/compliance/know-your-customer",
            "params": [
              {
                "name": "applicationId",
                "value": "",
                "type": "path",
                "description": "ID of application"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates or updates the Know Your Customer data for the specified application, including expected transaction values,  expected transaction volumes or trading name, incorporation date, business activities for business entities only."
        },
        {
          "info": {
            "name": "Create or Update Tax Residency Information for an Application Associate",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/applications/:applicationId/compliance/associates/:associateId/tax-residencies",
            "params": [
              {
                "name": "applicationId",
                "value": "",
                "type": "path",
                "description": "ID of application"
              },
              {
                "name": "associateId",
                "value": "",
                "type": "path",
                "description": "ID of associate"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates or updates the list of countries where an individual/associate is considered tax-resident, supporting compliance with CRS/FATCA and local tax rules."
        },
        {
          "info": {
            "name": "Create or Update Personal Details for an Application Associate",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/applications/:applicationId/compliance/associates/:associateId/personal-info",
            "params": [
              {
                "name": "applicationId",
                "value": "",
                "type": "path",
                "description": "ID of application"
              },
              {
                "name": "associateId",
                "value": "",
                "type": "path",
                "description": "ID of associate"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates or updates an individual/associate's personal details for the specified application, such as birth data, nationality, and sex."
        },
        {
          "info": {
            "name": "Get business entity for an Onboarding Application",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/applications/:applicationId/compliance/businesses",
            "params": [
              {
                "name": "applicationId",
                "value": "",
                "type": "path",
                "description": "ID of application"
              }
            ]
          },
          "docs": "Retrieves the business entity for the specified application, including key details such as business name, type and company registration number."
        },
        {
          "info": {
            "name": "Add a business entity to an Onboarding Application",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/applications/:applicationId/compliance/businesses",
            "params": [
              {
                "name": "applicationId",
                "value": "",
                "type": "path",
                "description": "ID of application"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new business entity with a unique identifier to the specified application, capturing key details such as business name, type and company registration number."
        },
        {
          "info": {
            "name": "Get business addresses for an Onboarding Application",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/applications/:applicationId/compliance/businesses/addresses",
            "params": [
              {
                "name": "applicationId",
                "value": "",
                "type": "path",
                "description": "ID of application"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "size",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves the business addresses recorded for the business linked to the specified application."
        },
        {
          "info": {
            "name": "Add a business address to an Onboarding Application",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/applications/:applicationId/compliance/businesses/addresses",
            "params": [
              {
                "name": "applicationId",
                "value": "",
                "type": "path",
                "description": "ID of application"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new business address, of type REGISTERED or TRADING, for the business linked to the specified application."
        },
        {
          "info": {
            "name": "Add an individual/associated entity to an Onboarding Application",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/applications/:applicationId/compliance/associates",
            "params": [
              {
                "name": "applicationId",
                "value": "",
                "type": "path",
                "description": "ID of application"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new individual/associated entity with a unique identifier to the specified application, capturing key details such as name, date of birth, address etc."
        },
        {
          "info": {
            "name": "Get all associates for a customer",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/associates",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of the customer"
              },
              {
                "name": "searchCriteria",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get all associates for a customer"
        }
      ]
    },
    {
      "info": {
        "name": "Accounts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get an account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts/:accountId",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account to fetch"
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query",
                "description": "Account statuses allowed when fetching the account"
              },
              {
                "name": "includePendingTransactions",
                "value": "",
                "type": "query",
                "description": "Include all pending transactions in 'balance' field"
              },
              {
                "name": "showAvailableBalance",
                "value": "",
                "type": "query",
                "description": "Show available balance"
              }
            ]
          },
          "docs": "Retrieve details of a particular account using its ID as a reference"
        },
        {
          "info": {
            "name": "Edit an account",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts/:accountId",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account to be edited"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Edit details of a particular account using its ID as a reference\nCurrently editable fields:\n  1. for accounts of all customer types, externalReference can be edited\n  2. for accounts of PCM_INDIVIDUAL & PCM_BUSINESS customer types, name can additionally be edited"
        },
        {
          "info": {
            "name": "Set the secured funding limit for an account",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts/:accountId/secured-funding",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account to set the secured funding limit"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set the secured funding limit for an account"
        },
        {
          "info": {
            "name": "Get accounts by customer",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/accounts",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of customer to fetch accounts for"
              },
              {
                "name": "customerStatuses",
                "value": "",
                "type": "query"
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query"
              },
              {
                "name": "minBalance",
                "value": "",
                "type": "query",
                "description": "Accounts with balance equal or more than this amount"
              },
              {
                "name": "maxBalance",
                "value": "",
                "type": "query",
                "description": "Accounts with balance equal or less than this amount"
              },
              {
                "name": "fromCreatedDate",
                "value": "2017-01-28T01:01:01+0000",
                "type": "query",
                "description": "Accounts created after and on this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000"
              },
              {
                "name": "toCreatedDate",
                "value": "2017-01-28T01:01:01+0000",
                "type": "query",
                "description": "Accounts created before and on this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of Page to fetch"
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query",
                "description": "Sort by field"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sorting order"
              },
              {
                "name": "currency",
                "value": "GBP",
                "type": "query",
                "description": "The currency for getting account by currency. Expected ISO Standard currency name i.e. GBP, EUR etc"
              },
              {
                "name": "showAvailableBalance",
                "value": "",
                "type": "query",
                "description": "Show available balance"
              }
            ]
          },
          "docs": "Get details of accounts belonging to a particular customer using the customer’s ID as a reference"
        },
        {
          "info": {
            "name": "Create account by customer",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/accounts",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of customer to create account for"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates an account for a particular customer using the customer’s ID as a reference"
        },
        {
          "info": {
            "name": "Unblock a specific account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts/:accountId/unblock",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account to unblock"
              }
            ]
          },
          "docs": "Using a unique reference (account ID) you can unblock an account"
        },
        {
          "info": {
            "name": "Close an account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts/:accountId/close",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account to close"
              }
            ]
          },
          "docs": "Accounts with a zero balance can be closed. The account must have a status of ACTIVE or CLIENT_BLOCKED."
        },
        {
          "info": {
            "name": "Block a specific account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts/:accountId/block",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account to block"
              }
            ]
          },
          "docs": "Using a unique reference (account ID) you can block an account"
        },
        {
          "info": {
            "name": "Get accounts using filter",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query"
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "ID or name of the account to search for"
              },
              {
                "name": "identifierType",
                "value": "SCAN",
                "type": "query",
                "description": "Accounts that contain this identifier type"
              },
              {
                "name": "name.type",
                "value": "",
                "type": "query",
                "description": "WORD_MATCH - using word boundaries,\nWORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,\nPREFIX - same case prefix,\nSUFFIX - same case suffix,\nCONTAINS - same case contains\nEXACT - same case exact\n"
              },
              {
                "name": "name.value",
                "value": "",
                "type": "query"
              },
              {
                "name": "externalReference.type",
                "value": "",
                "type": "query",
                "description": "WORD_MATCH - using word boundaries,\nWORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,\nPREFIX - same case prefix,\nSUFFIX - same case suffix,\nCONTAINS - same case contains\nEXACT - same case exact\n"
              },
              {
                "name": "externalReference.value",
                "value": "",
                "type": "query"
              },
              {
                "name": "customerId",
                "value": "C1234567",
                "type": "query",
                "description": "The customer ID for getting account by customer ID"
              },
              {
                "name": "accountNumber.type",
                "value": "",
                "type": "query",
                "description": "WORD_MATCH - using word boundaries,\nWORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,\nPREFIX - same case prefix,\nSUFFIX - same case suffix,\nCONTAINS - same case contains\nEXACT - same case exact\n"
              },
              {
                "name": "accountNumber.value",
                "value": "",
                "type": "query"
              },
              {
                "name": "iban.type",
                "value": "",
                "type": "query",
                "description": "WORD_MATCH - using word boundaries,\nWORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,\nPREFIX - same case prefix,\nSUFFIX - same case suffix,\nCONTAINS - same case contains\nEXACT - same case exact\n"
              },
              {
                "name": "iban.value",
                "value": "",
                "type": "query"
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query"
              },
              {
                "name": "minBalance",
                "value": "",
                "type": "query",
                "description": "Accounts with balance equal or more than this amount"
              },
              {
                "name": "maxBalance",
                "value": "",
                "type": "query",
                "description": "Accounts with balance equal or less than this amount"
              },
              {
                "name": "fromCreatedDate",
                "value": "2017-01-28T01:01:01+0000",
                "type": "query",
                "description": "Accounts created after and on this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000"
              },
              {
                "name": "toCreatedDate",
                "value": "2017-01-28T01:01:01+0000",
                "type": "query",
                "description": "Accounts created before and on this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of Page to fetch"
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query",
                "description": "Sort by field"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sorting order"
              },
              {
                "name": "currency",
                "value": "GBP",
                "type": "query",
                "description": "The currency for getting account by currency. Expected ISO Standard currency name i.e. GBP, EUR etc"
              },
              {
                "name": "showAvailableBalance",
                "value": "",
                "type": "query",
                "description": "Show available balance"
              }
            ]
          },
          "docs": "Gives the ability to find accounts and get their details using filters"
        }
      ]
    },
    {
      "info": {
        "name": "Access Group",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Update access group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/access-groups/:accessGroupId/content",
            "params": [
              {
                "name": "accessGroupId",
                "value": "",
                "type": "path",
                "description": "Access group ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The ability to update an access group's name and add or remove an account"
        },
        {
          "info": {
            "name": "Get a list of access groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/access-groups",
            "params": [
              {
                "name": "ids",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query"
              },
              {
                "name": "typeIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "accountIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "accountIdSearchCriteria.matchMode",
                "value": "",
                "type": "query"
              },
              {
                "name": "accountIdSearchCriteria.value",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "The ability to list all access groups for the customer"
        },
        {
          "info": {
            "name": "Create access group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/access-groups",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The ability to create a new access group"
        },
        {
          "info": {
            "name": "Get access group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/access-groups/:accessGroupId",
            "params": [
              {
                "name": "accessGroupId",
                "value": "",
                "type": "path",
                "description": "Access group ID"
              }
            ]
          },
          "docs": "The ability to retrieve an access group by ID"
        }
      ]
    },
    {
      "info": {
        "name": "Beneficiaries",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a new beneficiary for a specified customer",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/beneficiaries",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of customer to create beneficiary for"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The ability to create a new beneficiary for a customer, using their customer ID as a reference."
        },
        {
          "info": {
            "name": "Delete beneficiaries for a specified customer",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/beneficiaries",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of customer to delete beneficiaries for"
              },
              {
                "name": "bid",
                "value": "",
                "type": "query",
                "description": "ID(s) of beneficiaries to delete, must owned by customer and active"
              }
            ]
          },
          "docs": "deleting beneficiaries for a customer, using their customer ID"
        },
        {
          "info": {
            "name": "Retrieve beneficiaries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/beneficiaries",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Id of Beneficiary(s) to fetch"
              },
              {
                "name": "customerId",
                "value": "",
                "type": "query",
                "description": "Filter by Customer Id"
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "Partial name of beneficiary or Scan Details Or IBAN Or external referenceOr default reference to search for. Deprecated use validForAccount, orSortCode, orAccountNumber, orIban, orName, orExternalReference, orDefaultReference instead"
              },
              {
                "name": "modifiedSince",
                "value": "",
                "type": "query",
                "description": "Beneficiaries modified after this date time"
              },
              {
                "name": "hasExternalReference",
                "value": "",
                "type": "query",
                "description": "Filter by existence of external reference"
              },
              {
                "name": "externalReference",
                "value": "",
                "type": "query",
                "description": "External reference for beneficiary"
              },
              {
                "name": "iban",
                "value": "",
                "type": "query",
                "description": "IBAN"
              },
              {
                "name": "abaRoutingNumber",
                "value": "",
                "type": "query",
                "description": "abaRoutingNumber"
              },
              {
                "name": "currency",
                "value": "",
                "type": "query",
                "description": "Currency"
              },
              {
                "name": "qualifier",
                "value": "",
                "type": "query",
                "description": "A list of external qualifiers"
              },
              {
                "name": "state",
                "value": "",
                "type": "query",
                "description": "Approval item state(s) to filter by"
              },
              {
                "name": "validForAccount",
                "value": "A000000001",
                "type": "query",
                "description": "Source account BID. Limit results to beneficiaries which would be valid recipients of payments from the given account (e.g. IBAN can’t be paid from GBP account, SCAN can’t be paid from non-GBP account). The specified account must be accessible to the user"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order"
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query",
                "description": "Sort by field, This defaults to name if not present"
              },
              {
                "name": "orSortCode.type",
                "value": "",
                "type": "query",
                "description": "WORD_MATCH - using word boundaries,\nWORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,\nPREFIX - same case prefix,\nSUFFIX - same case suffix,\nCONTAINS - same case contains\nEXACT - same case exact\n"
              },
              {
                "name": "orSortCode.value",
                "value": "",
                "type": "query"
              },
              {
                "name": "orAccountNumber.type",
                "value": "",
                "type": "query",
                "description": "WORD_MATCH - using word boundaries,\nWORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,\nPREFIX - same case prefix,\nSUFFIX - same case suffix,\nCONTAINS - same case contains\nEXACT - same case exact\n"
              },
              {
                "name": "orAccountNumber.value",
                "value": "",
                "type": "query"
              },
              {
                "name": "orIban.type",
                "value": "",
                "type": "query",
                "description": "WORD_MATCH - using word boundaries,\nWORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,\nPREFIX - same case prefix,\nSUFFIX - same case suffix,\nCONTAINS - same case contains\nEXACT - same case exact\n"
              },
              {
                "name": "orIban.value",
                "value": "",
                "type": "query"
              },
              {
                "name": "orAbaRoutingNumber.type",
                "value": "",
                "type": "query",
                "description": "WORD_MATCH - using word boundaries,\nWORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,\nPREFIX - same case prefix,\nSUFFIX - same case suffix,\nCONTAINS - same case contains\nEXACT - same case exact\n"
              },
              {
                "name": "orAbaRoutingNumber.value",
                "value": "",
                "type": "query"
              },
              {
                "name": "orName.type",
                "value": "",
                "type": "query",
                "description": "WORD_MATCH - using word boundaries,\nWORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,\nPREFIX - same case prefix,\nSUFFIX - same case suffix,\nCONTAINS - same case contains\nEXACT - same case exact\n"
              },
              {
                "name": "orName.value",
                "value": "",
                "type": "query"
              },
              {
                "name": "orExternalReference.type",
                "value": "",
                "type": "query",
                "description": "WORD_MATCH - using word boundaries,\nWORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,\nPREFIX - same case prefix,\nSUFFIX - same case suffix,\nCONTAINS - same case contains\nEXACT - same case exact\n"
              },
              {
                "name": "orExternalReference.value",
                "value": "",
                "type": "query"
              },
              {
                "name": "orDefaultReference.type",
                "value": "",
                "type": "query",
                "description": "WORD_MATCH - using word boundaries,\nWORD_MATCH_ALPHANUMERIC - using word boundaries, but replaces non-alphanumeric characters in the search with a word boundary match,\nPREFIX - same case prefix,\nSUFFIX - same case suffix,\nCONTAINS - same case contains\nEXACT - same case exact\n"
              },
              {
                "name": "orDefaultReference.value",
                "value": "",
                "type": "query"
              },
              {
                "name": "createdDate",
                "value": "",
                "type": "query",
                "description": "Created date"
              },
              {
                "name": "partialName",
                "value": "",
                "type": "query",
                "description": "Partial name"
              },
              {
                "name": "sortCode",
                "value": "",
                "type": "query",
                "description": "Sort code"
              },
              {
                "name": "accountNumber",
                "value": "",
                "type": "query",
                "description": "Account number"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of Page to fetch"
              }
            ]
          },
          "docs": "The ability to get the details of beneficiaries using various pieces of information, e.g. using customer ID, retrieve all beneficiaries created by that customer. Can get details of one particular beneficiary based on the unique beneficiary reference number."
        },
        {
          "info": {
            "name": "Retrieve locked beneficiary entities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/beneficiaries/:beneficiaryId/locks",
            "params": [
              {
                "name": "beneficiaryId",
                "value": "",
                "type": "path"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of Page to fetch"
              }
            ]
          },
          "docs": "Fetch references of the entities (payment, rule) that have caused the beneficiary to be locked"
        }
      ]
    },
    {
      "info": {
        "name": "Transactions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get transactions for a specific Account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts/:accountId/transactions",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "ID of account to fetch transactions for"
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "Partial description text to search for"
              },
              {
                "name": "minAmount",
                "value": "",
                "type": "query",
                "description": "Transactions with amount equal or more than this amount"
              },
              {
                "name": "maxAmount",
                "value": "",
                "type": "query",
                "description": "Transactions with amount equal or less than this amount"
              },
              {
                "name": "fromPostedDate",
                "value": "",
                "type": "query",
                "description": "Transactions with posted date equal or after to this date"
              },
              {
                "name": "toPostedDate",
                "value": "",
                "type": "query",
                "description": "Transactions with posted date equal or before to this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000"
              },
              {
                "name": "type",
                "value": "",
                "type": "query"
              },
              {
                "name": "credit",
                "value": "",
                "type": "query",
                "description": "If true only credit transactions will be returned, if false, only debit transactions will be returned"
              },
              {
                "name": "sourceId",
                "value": "",
                "type": "query",
                "description": "Transactions with this sourceId"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of Page to fetch"
              },
              {
                "name": "showAvailableBalance",
                "value": "",
                "type": "query",
                "description": "Show available balance"
              },
              {
                "name": "fromTransactionDate",
                "value": "",
                "type": "query",
                "description": "Transactions with transaction date equal or after to this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000"
              },
              {
                "name": "toTransactionDate",
                "value": "",
                "type": "query",
                "description": "Transactions with transaction date equal or before to this date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              }
            ]
          },
          "docs": "Retrieves the last 6 months of transactions (successful payments in & out) of an account, specified by a unique account reference."
        }
      ]
    },
    {
      "info": {
        "name": "Payments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve payments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/payments",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Payment ID. If specified then all other parameters are ignored. Use ids to search for multiple payment IDs"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query"
              },
              {
                "name": "fromCreatedDate",
                "value": "2016-01-01T01:01:01+0000",
                "type": "query",
                "description": "Payments created date equal or after to this date. Mandatory Parameter(except when 'id', 'ids', 'fxQuoteId' or 'modifiedSince' parameter is used)"
              },
              {
                "name": "toCreatedDate",
                "value": "",
                "type": "query",
                "description": "Payments created date equal or before to this date"
              },
              {
                "name": "modifiedSince",
                "value": "",
                "type": "query",
                "description": "Payments modified date equal or before to this date"
              },
              {
                "name": "fromUpdatedDate",
                "value": "2016-01-01T01:01:01+0000",
                "type": "query",
                "description": "Payments updated date equal or after to this date."
              },
              {
                "name": "toUpdatedDate",
                "value": "2016-01-01T01:01:01+0000",
                "type": "query",
                "description": "Payments updated date equal or before to this date."
              },
              {
                "name": "sourceAccountId",
                "value": "",
                "type": "query",
                "description": "The source account ID"
              },
              {
                "name": "hasExternalReference",
                "value": "",
                "type": "query",
                "description": "True if the API should return all items that have externalReference. False the API should return all items that don't have externalReference"
              },
              {
                "name": "externalReference",
                "value": "",
                "type": "query",
                "description": "External reference can only have alphanumeric characters plus underscore, hyphen and space"
              },
              {
                "name": "status",
                "value": "",
                "type": "query"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The payment type to search for."
              },
              {
                "name": "excludeBatchPayments",
                "value": "",
                "type": "query",
                "description": "Exclude payments which are part of a batch with submission type BATCH"
              },
              {
                "name": "batchPaymentId",
                "value": "",
                "type": "query",
                "description": "Filter on batch"
              },
              {
                "name": "reversals",
                "value": "",
                "type": "query",
                "description": "Filter on reversals"
              },
              {
                "name": "schemeId",
                "value": "",
                "type": "query",
                "description": "Filter on scheme ID"
              },
              {
                "name": "approvalStatus",
                "value": "",
                "type": "query",
                "description": "Payment approval status, multiple statuses can be specified by repeating the parameter"
              },
              {
                "name": "currency",
                "value": "",
                "type": "query"
              },
              {
                "name": "minAmount",
                "value": "5.5",
                "type": "query",
                "description": "Payments amount equal or greater than this amount"
              },
              {
                "name": "maxAmount",
                "value": "50.5",
                "type": "query",
                "description": "Payments amount equal or less than this amount"
              },
              {
                "name": "fromPaymentScheduledDate",
                "value": "2022-01-01T01:01:01+0000",
                "type": "query",
                "description": "Payments scheduled date equal or after to this date"
              },
              {
                "name": "toPaymentScheduledDate",
                "value": "2023-01-01T01:01:01+0000",
                "type": "query",
                "description": "Payments scheduled date equal or before to this date and in absence of fromPaymentDate, payments executed prior to 180 days from this date"
              },
              {
                "name": "customerId",
                "value": "C1234567",
                "type": "query",
                "description": "Filter on customer ID"
              },
              {
                "name": "currentUserCanApprove",
                "value": "true",
                "type": "query",
                "description": "Only return payments the current user can approve."
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query",
                "description": "Sort by field. Sorted by createdDate if not present"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sorting order:\n1. asc -> ascending\n2. desc -> descending"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page to fetch. 0 indexed"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "The size of the page(s)"
              }
            ]
          },
          "docs": "The ability to get the details of payments using various pieces of information, e.g. using Account ID, retrieve all payments in that account. Can get details of one particular payment based on the unique payment reference number."
        },
        {
          "info": {
            "name": "Create a payment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/payments",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Supports both Payments to external bank accounts via Faster Payments and transfers to other Modulr accounts. Requests to Payments are asynchronous."
        },
        {
          "info": {
            "name": "Get batch payments by a given set of parameters",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/batchpayments",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "List of batch payment IDs"
              },
              {
                "name": "externalReference",
                "value": "aReference_00001",
                "type": "query",
                "description": "Batch payments External Reference contains this text."
              },
              {
                "name": "fromCreatedDate",
                "value": "2022-05-16",
                "type": "query",
                "description": "Batch payments created date equal or after to this date."
              },
              {
                "name": "toCreatedDate",
                "value": "2026-06-08",
                "type": "query",
                "description": "Batch payments created date equal or before this date."
              },
              {
                "name": "batchPaymentStatuses",
                "value": "",
                "type": "query"
              },
              {
                "name": "paymentStatuses",
                "value": "",
                "type": "query"
              },
              {
                "name": "approvalStatus",
                "value": "",
                "type": "query"
              },
              {
                "name": "currentUserCanApprove",
                "value": "true",
                "type": "query",
                "description": "Only return batch payments the current user can approve."
              },
              {
                "name": "createdByCustomerId",
                "value": "",
                "type": "query",
                "description": "Limit results by the customer which created the batch payment request"
              },
              {
                "name": "submissionType",
                "value": "",
                "type": "query",
                "description": "Limit results to batches with submission type specified"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of Page to fetch"
              }
            ]
          },
          "docs": "This endpoint allows for a user who has submitted multiple batch to use some criteria to get the batch payments."
        },
        {
          "info": {
            "name": "Make a batch payment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/batchpayments",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "As well as supporting individual payment requests, the Modulr payment platform can also handle multiple payment objects in the same request. This endpoint allows you to make a new batch payment."
        },
        {
          "info": {
            "name": "Cancel the batch payment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/batchpayments/:batchPaymentId/cancel",
            "params": [
              {
                "name": "batchPaymentId",
                "value": "",
                "type": "path",
                "description": "Batch payment request id"
              }
            ]
          },
          "docs": "Cancels a batch payment request if it is not already processed"
        },
        {
          "info": {
            "name": "Get batch payment by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/batchpayments/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "id given when batch request was made"
              }
            ]
          },
          "docs": "Get the details of an existing batch payment by ID"
        }
      ]
    },
    {
      "info": {
        "name": "Rules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Edit a specific Rule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/rules/:ruleId",
            "params": [
              {
                "name": "ruleId",
                "value": "",
                "type": "path",
                "description": "Id of Rule to be edited"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The ability to modify the details of a specific rule based on the rule's unique reference."
        },
        {
          "info": {
            "name": "Create a Rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/rules",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "When you want a new rule on an account you can create one with this endpoint. Note that Rules are linked to an Account and each Account can only have one instance of a Rule type"
        },
        {
          "info": {
            "name": "Delete a Rule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/rules",
            "params": [
              {
                "name": "rIds",
                "value": "",
                "type": "query",
                "description": "Id(s) of Rules to delete"
              }
            ]
          },
          "docs": "When you no longer want a rule on an account you can do it with this endpoint. You can delete more than one rule in the same request."
        },
        {
          "info": {
            "name": "Get all Rules for a specific Account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts/:id/rules",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Account ID of the rules"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of Page to fetch"
              },
              {
                "name": "rtype",
                "value": "SPLIT, SWEEP, FUNDING",
                "type": "query",
                "description": "Filter to a specific RuleType"
              }
            ]
          },
          "docs": "The ability to get the details of all rules associated with the specified account using the Account ID as a reference. Can filter by a specific type using the type parameter."
        },
        {
          "info": {
            "name": "Retrieve a Rule by rule type on a specific account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts/:id/rules/:rtype",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Account ID of the rule"
              },
              {
                "name": "rtype",
                "value": "SPLIT, SWEEP, FUNDING",
                "type": "path",
                "description": "The type of Rule."
              }
            ]
          },
          "docs": "You need to know the unique reference of the account and the rule type you want to get to information on."
        }
      ]
    },
    {
      "info": {
        "name": "Notification",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a specific notification by unique reference for a specific partner",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/partners/:partnerId/notifications/:notificationId",
            "params": [
              {
                "name": "partnerId",
                "value": "",
                "type": "path"
              },
              {
                "name": "notificationId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This allows you to see the settings for a particular notification that has been set up, for example if you want to check if it is active or the emails the notification is being sent to. It would be best practice to call this before updating a notification."
        },
        {
          "info": {
            "name": "Update a specific notification by unique reference for a specific partner",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/partners/:partnerId/notifications/:notificationId",
            "params": [
              {
                "name": "partnerId",
                "value": "",
                "type": "path"
              },
              {
                "name": "notificationId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "If you need to change anything about a particular notification, for example add an email address or make it inactive, then this is the endpoint to use. You need to put all of the information into this request for the notification even if it isn't changing, so either you will need to record this somewhere when you create the notification, or call the 'GET' request first."
        },
        {
          "info": {
            "name": "Retrieve a specific notification by unique reference for a specific customer",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/notifications/:notificationId",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path"
              },
              {
                "name": "notificationId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This allows you to see the settings for a particular notification that has been set up, for example if you want to check if it is active or the emails the notification is being sent to. It would be best practice to call this before updating a notification."
        },
        {
          "info": {
            "name": "Update a specific notification by unique reference for a specific customer",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/notifications/:notificationId",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path"
              },
              {
                "name": "notificationId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "If you need to change anything about a particular notification, for example add an email address or make it inactive, then this is the endpoint to use. You need to put all of the information into this request for the notification even if it isn't changing, so either you will need to record this somewhere when you create the notification, or call the 'GET' request first."
        },
        {
          "info": {
            "name": "Get all Notifications linked directly to a Partner",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/partners/:partnerId/notifications",
            "params": [
              {
                "name": "partnerId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve details of all notifications set up for a partner using the partner's ID as a reference"
        },
        {
          "info": {
            "name": "Set up a Notification for a Partner",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/partners/:partnerId/notifications",
            "params": [
              {
                "name": "partnerId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sets up a new notification for a partner using the partner's ID as a reference. Returns a notification ID that should be saved if the notification needs to be amended in the future"
        },
        {
          "info": {
            "name": "Get all Notifications for a Customer",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/notifications",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve details of all notifications set up for a customer using the customer's ID as a reference"
        },
        {
          "info": {
            "name": "Set up a Notification for a Customer",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/notifications",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sets up a new notification for a customer using the customer's ID as a reference. Returns a notification ID that should be saved if the notification needs to be amended in the future"
        },
        {
          "info": {
            "name": "Check if a particular webhook has failed",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/webhooks/:webhookId/failures",
            "params": [
              {
                "name": "webhookId",
                "value": "",
                "type": "path",
                "description": "Id of Webhook "
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Failed since Date. Needs to be urlEncoded value"
              }
            ]
          },
          "docs": "Only supports webhook notifications and as such uses the webhook endpoint. Request a specific notification ID and specify you want to see failures. (Max 50)"
        }
      ]
    },
    {
      "info": {
        "name": "Inbound Payments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Endpoint to mock the credit of an account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/credit",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Inbound payments - mock (Sandbox only)"
        }
      ]
    },
    {
      "info": {
        "name": "Direct Debits",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create the collection schedule for the given mandate-id.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/mandates/:mandateId/collectionschedules",
            "params": [
              {
                "name": "mandateId",
                "value": "",
                "type": "path",
                "description": "Id of mandate to create collection for."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a Direct Debit collection schedule; the agreed to framework for the collections for the given mandate-id. This could be a single collection or multiple and includes the frequency and amounts of the planned payments."
        },
        {
          "info": {
            "name": "Cancel Mandate for given mandate-id.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/mandates/:mandateId/cancel",
            "params": [
              {
                "name": "mandateId",
                "value": "",
                "type": "path",
                "description": "Id of Mandate to cancel."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Cancel Mandate for given mandate-id."
        },
        {
          "info": {
            "name": "Bulk request of Direct Debit mandates for the given account-id.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/mandates/bulk-create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk request of Direct Debit mandates for the given account-id."
        },
        {
          "info": {
            "name": "Bulk mandate cancellation request for the given account-id.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/mandates/bulk-cancel",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk mandate cancellation request for the given account-id."
        },
        {
          "info": {
            "name": "Cancel a Direct Debit collection schedule for the given collection-id.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/collectionschedules/:collectionScheduleId/cancel",
            "params": [
              {
                "name": "collectionScheduleId",
                "value": "",
                "type": "path",
                "description": "Id of the collectionSchedule to cancel"
              }
            ]
          },
          "docs": "Cancel a Direct Debit collection schedule for the given collection-id."
        },
        {
          "info": {
            "name": "Cancel a Direct Debit collection for the given collection-id.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/collections/:collectionId/cancel",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "Id of the collection to cancel"
              }
            ]
          },
          "docs": "Cancel a Direct Debit collection for the given collection-id."
        },
        {
          "info": {
            "name": "Represent collection for given collection id",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/collection/:collectionId/represent",
            "params": [
              {
                "name": "collectionId",
                "value": "",
                "type": "path",
                "description": "Id of collection to represent"
              }
            ]
          },
          "docs": "Represent collection for given collection id"
        },
        {
          "info": {
            "name": "Create a Direct Debit mandate for the given account-id.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts/:accountId/mandates",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "Id of account to create Direct Debit for."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Setting up a Mandate is the first step in creating a Direct Debit. You can only set up scheduled payments ('collections') after there is a Mandate created with the details of the payee."
        },
        {
          "info": {
            "name": "Get Reconciliations based on search criteria.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/reconciliations",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "query",
                "description": "Id(s) of account to fetch Reconciliations for."
              },
              {
                "name": "collectionDate",
                "value": "",
                "type": "query",
                "description": "Reconciliation entry for date."
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query"
              },
              {
                "name": "size",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Use this endpoint to get a list of Reconciliations for a given account and date."
        },
        {
          "info": {
            "name": "Get Mandates based on search criteria.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/mandates",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query"
              },
              {
                "name": "accountId",
                "value": "",
                "type": "query"
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "Query parameter. ID, name or reference of mandate to search for"
              },
              {
                "name": "fromCreatedDate",
                "value": "",
                "type": "query",
                "description": "Mandates created on or after this date."
              },
              {
                "name": "toCreatedDate",
                "value": "",
                "type": "query",
                "description": "Mandates created on or before this date."
              },
              {
                "name": "fromSubmittedDate",
                "value": "",
                "type": "query",
                "description": "Mandates submitted on or after this date."
              },
              {
                "name": "toSubmittedDate",
                "value": "",
                "type": "query",
                "description": "Mandates submitted on or before this date."
              },
              {
                "name": "status",
                "value": "",
                "type": "query"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Account Name on the Mandate"
              },
              {
                "name": "reference",
                "value": "",
                "type": "query",
                "description": "reference of the Mandate"
              },
              {
                "name": "externalReference",
                "value": "",
                "type": "query",
                "description": "externalReference of the Mandate"
              },
              {
                "name": "bulkCreateRequestId",
                "value": "",
                "type": "query",
                "description": "Bulk create request ID"
              },
              {
                "name": "bulkCancelRequestId",
                "value": "",
                "type": "query",
                "description": "Bulk cancel request ID"
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query",
                "description": "Sort by field"
              },
              {
                "name": "sortOrder",
                "value": "asc",
                "type": "query",
                "description": "Sort order"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (zero-indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of page to fetch."
              }
            ]
          },
          "docs": "If trying to find one or several particular mandates, then you can narrow down your search by using the filters available here. These include the mandate id, either the submitted or created date range, the account name on the mandate, etc..."
        },
        {
          "info": {
            "name": "Get Indemnity Claims based on search criteria",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/indemnity-claims",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "query",
                "description": "Collection Account Id"
              },
              {
                "name": "indemnityClaimIds",
                "value": "ICC1234567",
                "type": "query",
                "description": "List of Indemnity Claim Id's"
              },
              {
                "name": "ddicReferences",
                "value": "DDICreference",
                "type": "query",
                "description": "List of DDIC references, these are references related to the claim itself. Must start with DDIC. This is different to the reference used on the mandate, it is generated by the claim originator"
              },
              {
                "name": "serviceUserReferences",
                "value": "",
                "type": "query",
                "description": "List of mandate/ddi references that claims are related to."
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query",
                "description": "List of statuses that claims are in."
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query"
              },
              {
                "name": "size",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns a list of Indemnity Claim Advice's based on the parameters provided."
        },
        {
          "info": {
            "name": "Get an Indemnity Claim for a given id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/indemnity-claims/:indemnityClaimId",
            "params": [
              {
                "name": "indemnityClaimId",
                "value": "",
                "type": "path",
                "description": "Id of the indemnityClaim"
              }
            ]
          },
          "docs": "Returns a singular Indemnity Claim based on the ID supplied in the path."
        },
        {
          "info": {
            "name": "Get all collectionschedules for a mandate",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/collectionschedules",
            "params": [
              {
                "name": "mandateId",
                "value": "",
                "type": "query",
                "description": "Mandate Id to fetch collections for."
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query",
                "description": "Sort by field"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (zero-indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of page to fetch."
              }
            ]
          },
          "docs": "By supplying the mandate id you can view all information regarding the collection schedules linked to that mandate."
        },
        {
          "info": {
            "name": "Get all collection activities of an account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/collections",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "query",
                "description": "Account Id to fetch collections items for."
              },
              {
                "name": "mandateId",
                "value": "",
                "type": "query",
                "description": "Id of mandate whose the collection to fetch."
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "type of collection to fetch"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "Collection activities happened on or after this date"
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "Collection item activities happened on or before this date"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query"
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "size",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Once a collection schedule is set up, any past collections (whether successful or not) can be retrieved.\nThis endpoint supports only paginated responses with the default page size of 20 (min 1, max 500).\n"
        }
      ]
    },
    {
      "info": {
        "name": "Share secure card details",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a single share secure card details record",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/share-secure-details/:shareSecureDetailsId",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card to retrieve the share secure card details for"
              },
              {
                "name": "shareSecureDetailsId",
                "value": "",
                "type": "path",
                "description": "The id of the token whose share secure card details is being retrieved"
              },
              {
                "name": "includeActivity",
                "value": "",
                "type": "query",
                "description": "Flag whether to include the activities of the token"
              }
            ]
          },
          "docs": "This endpoint retrieves a specific share secure card details record for a given card and share details token id"
        },
        {
          "info": {
            "name": "Update share secure details",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/share-secure-details/:shareSecureDetailsId",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card to update share secure card details for"
              },
              {
                "name": "shareSecureDetailsId",
                "value": "",
                "type": "path",
                "description": "The ID of the share secure card details to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoints allows updating the share secure card details"
        },
        {
          "info": {
            "name": "Retrieve share secure card details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/share-secure-details",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card to retrieve share secure card details for"
              },
              {
                "name": "excludeTerminated",
                "value": "",
                "type": "query",
                "description": "Exclude terminated share secure card details"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of page to fetch"
              }
            ]
          },
          "docs": "This endpoint allows the user to retrieve the share secure card details for a specific card"
        },
        {
          "info": {
            "name": "Share secure card details via EMAIL or RETURN methods",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/share-secure-details",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card to share secure card details for"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows the user to create a link to share secure card details for a specific card"
        },
        {
          "info": {
            "name": "Delete all share secure card details for a card",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/share-secure-details",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card to delete share secure card details for"
              }
            ]
          },
          "docs": "This endpoint allows the user to delete the link to share secure card details for a specific card"
        },
        {
          "info": {
            "name": "Retrieve share details activity of token",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/share-secure-details/:shareSecureDetailsId/activity",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card to retrieve share secure card details activity for"
              },
              {
                "name": "shareSecureDetailsId",
                "value": "",
                "type": "path",
                "description": "The ID of the share secure card details to retrieve activity for"
              }
            ]
          },
          "docs": "This endpoint allows the user to retrieve the share secure card details activity for a specific share token"
        },
        {
          "info": {
            "name": "Delete share secure card details",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/share-secure-details/:shareId",
            "params": [
              {
                "name": "shareId",
                "value": "",
                "type": "path",
                "description": "The id of the share secure card details to delete"
              }
            ]
          },
          "docs": "This endpoint allows the user to delete the share secure card details for a specific Id"
        }
      ]
    },
    {
      "info": {
        "name": "Cards",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Update card authentication",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/authentication",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card which has authentication information to be updated"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Support knowledge based authentication (KBA)"
        },
        {
          "info": {
            "name": "Retrieve card report type notification configuration for partner",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/partners/:partnerId/card-report-types/:reportType/notifications",
            "params": [
              {
                "name": "partnerId",
                "value": "",
                "type": "path",
                "description": "Id of partner to retrieve report type notification configuration for"
              },
              {
                "name": "reportType",
                "value": "",
                "type": "path",
                "description": "Type of report partner wants to retrieve notification configuration for"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of page to fetch"
              }
            ]
          },
          "docs": "Retrieve card report type notification configuration for partner"
        },
        {
          "info": {
            "name": "Update report type notification configuration for partner",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/partners/:partnerId/card-report-types/:reportType/notifications",
            "params": [
              {
                "name": "partnerId",
                "value": "",
                "type": "path",
                "description": "Id of partner to set up notification for"
              },
              {
                "name": "reportType",
                "value": "",
                "type": "path",
                "description": "Type of report partner wants notification sent for"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update report type notification configuration for partner"
        },
        {
          "info": {
            "name": "Delete card report notification configuration for partner and report type",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/partners/:partnerId/card-report-types/:reportType/notifications",
            "params": [
              {
                "name": "partnerId",
                "value": "",
                "type": "path",
                "description": "Id of partner to remove notification for"
              },
              {
                "name": "reportType",
                "value": "",
                "type": "path",
                "description": "Type of report partner is unsubscribing notification for"
              }
            ]
          },
          "docs": "Delete card report notification configuration for partner and report type"
        },
        {
          "info": {
            "name": "Toggle card report notification for partner and report type",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/partners/:partnerId/card-report-types/:reportType/notifications/status",
            "params": [
              {
                "name": "partnerId",
                "value": "",
                "type": "path",
                "description": "Id of partner to toggle notification for"
              },
              {
                "name": "reportType",
                "value": "",
                "type": "path",
                "description": "Type of report partner wants notification toggled for"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Toggle card report notification for partner and report type"
        },
        {
          "info": {
            "name": "Bulk create partner custom field keys",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/partner/:partnerId/bulk-card-custom-fields",
            "params": [
              {
                "name": "partnerId",
                "value": "",
                "type": "path",
                "description": "Id of partner to create custom fields for"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk create partner custom field keys"
        },
        {
          "info": {
            "name": "Retrieve card report type notification configuration for customer",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/card-report-types/:reportType/notifications",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "Id of customer to retrieve report type notification configuration for"
              },
              {
                "name": "reportType",
                "value": "",
                "type": "path",
                "description": "Type of report customer wants to retrieve notification configuration for"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of page to fetch"
              }
            ]
          },
          "docs": "Retrieve card report type notification configuration for customer"
        },
        {
          "info": {
            "name": "Update report type notification configuration for customer",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/card-report-types/:reportType/notifications",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "Id of customer to set up notification for"
              },
              {
                "name": "reportType",
                "value": "",
                "type": "path",
                "description": "Type of report customer wants notification sent for"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update report type notification configuration for customer"
        },
        {
          "info": {
            "name": "Delete card report notification configuration for customer and report type",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/card-report-types/:reportType/notifications",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "Id of customer to remove notification for"
              },
              {
                "name": "reportType",
                "value": "",
                "type": "path",
                "description": "Type of report customer is unsubscribing notification for"
              }
            ]
          },
          "docs": "Delete card report notification configuration for customer and report type"
        },
        {
          "info": {
            "name": "Toggled notifications for customer and card report type",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/card-report-types/:reportType/notifications/status",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "Id of customer to toggle notification for"
              },
              {
                "name": "reportType",
                "value": "",
                "type": "path",
                "description": "Type of report customer wants notification toggled for"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Toggled notifications for customer and card report type"
        },
        {
          "info": {
            "name": "Bulk create customer custom field keys",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customer/:customerId/bulk-card-custom-fields",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "Id of customer to create custom fields for"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk create customer custom field keys"
        },
        {
          "info": {
            "name": "View the details of an existing card",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card to view"
              }
            ]
          },
          "docs": "View the details of an existing card"
        },
        {
          "info": {
            "name": "Update a card",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card to be updated"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update card and cardholder details"
        },
        {
          "info": {
            "name": "Update card",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update card - for now, the removal of cancellationDate, authWindowStartDate and authWindowEndDate fields and the update of frequencyUsage field are the only allowed actions"
        },
        {
          "info": {
            "name": "Unblock an existing card",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/unblock",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card which should be unblocked"
              }
            ]
          },
          "docs": "Unblocking a card re-enables normal authorisation processing."
        },
        {
          "info": {
            "name": "Create secure card details token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/secure-details-token",
            "headers": [
              {
                "name": "X-MOD-CARD-MGMT-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card to generate the token"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a token that is used as a parameter to retrieve secure card details (PAN, CVV, and PIN) or to perform PIN alterations. This token is to be retrieved by the partner and pushed to the cardholder device where the call is made. The token will be valid for 60 seconds."
        },
        {
          "info": {
            "name": "Replace a card",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/replace",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replace a card, with a reason STOLEN, DAMAGED, LOST, RENEW."
        },
        {
          "info": {
            "name": "Retrieve PIN",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/pin",
            "headers": [
              {
                "name": "X-MOD-CARD-MGMT-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card to retrieve the PIN for"
              }
            ]
          },
          "docs": "Retrieves the PIN for a card, as a reminder for the cardholder"
        },
        {
          "info": {
            "name": "Reset card PIN",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/pin",
            "headers": [
              {
                "name": "X-MOD-CARD-MGMT-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card to reset the PIN for"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Reset the card's PIN for a specific card"
        },
        {
          "info": {
            "name": "Unblock PIN",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/pin/unblock",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card to unblock the PIN (and/or CVC2) against"
              }
            ]
          },
          "docs": "Unblock the card's PIN so that it can be used by the cardholder. CVC2 will also be unblocked, where required."
        },
        {
          "info": {
            "name": "Get in-app provisioning data for Apple Pay",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/in-app-provisioning/apple",
            "params": [
              {
                "name": "cardId",
                "value": "V110000001",
                "type": "path",
                "description": "Card ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Retrieves and encrypts the data needed for the client application to provision a card to Apple Pay"
        },
        {
          "info": {
            "name": "Update a card's custom fields",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/custom-fields",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "Id of the card for which the custom fields should be updated"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replace the values of a card's custom fields if they exist or create new custom fields with the given values if they do not exist"
        },
        {
          "info": {
            "name": "Cancel an existing card",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/cancel",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card which should be cancelled"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Cancelling a card _**permanently**_ disables authorisation processing & _**destroys**_ the card from the card scheme perspective. This means that all _new_ authorisations will be immediately declined and this cannot be reversed. Outstanding authorisations are unaffected and settlement, chargebacks, refunds, etc will continue to function as normal."
        },
        {
          "info": {
            "name": "Block an existing card",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/block",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card which should be blocked"
              }
            ]
          },
          "docs": "Blocking a card temporarily disables authorisation processing. This means that all _new_ authorisations will be immediately declined. Outstanding authorisations are unaffected and settlement, chargebacks, refunds, etc will continue to function as normal."
        },
        {
          "info": {
            "name": "Activate a physical card",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/activate",
            "headers": [
              {
                "name": "X-MOD-CARD-MGMT-TOKEN",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the physical card which should be activated."
              }
            ]
          },
          "docs": "Physical cards issued by Modulr will be mailed out to cardholders in an inactive state. A cardholder will need to have their card activated before it can be used. Cards can only be activated whilst they have a status of `CREATED`."
        },
        {
          "info": {
            "name": "Reset card PIN",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/secure-pin-reset",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Reset the PIN for a card using a client access token. This should be done from the card-holder device and not directly by the partner"
        },
        {
          "info": {
            "name": "Card enquiry",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/enquiry",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Retrieve card details by PAN"
        },
        {
          "info": {
            "name": "Unsuspend card token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/card-tokens/:tokenId/unsuspend",
            "params": [
              {
                "name": "tokenId",
                "value": "T110000001",
                "type": "path",
                "description": "Card token ID"
              }
            ]
          },
          "docs": "Restores a previously suspended token to active"
        },
        {
          "info": {
            "name": "Suspend card token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/card-tokens/:tokenId/suspend",
            "params": [
              {
                "name": "tokenId",
                "value": "T110000001",
                "type": "path",
                "description": "Card token ID"
              }
            ]
          },
          "docs": "Suspends a token to temporarily prevent any new authorisations"
        },
        {
          "info": {
            "name": "Deactivate card token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/card-tokens/:tokenId/deactivate",
            "params": [
              {
                "name": "tokenId",
                "value": "T110000001",
                "type": "path",
                "description": "Card token ID"
              }
            ]
          },
          "docs": "Deactivating a token permanently disables authorisation processing. This action is irreversible"
        },
        {
          "info": {
            "name": "Create a new physical card",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts/:accountId/physical-cards",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "The account which card funds will be raised from."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Asynchronously create a physical card. The response will include a resource to allow the client to check the status of the request."
        },
        {
          "info": {
            "name": "View the details of existing cards by account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts/:accountId/cards",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "Account ID"
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query",
                "description": "Statuses of cards to be retrieved"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "size",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "View the details of existing cards by account"
        },
        {
          "info": {
            "name": "Create a new virtual card",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts/:accountId/cards",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "The account which card funds will be raised from."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new virtual card"
        },
        {
          "info": {
            "name": "View existing partner card custom field keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/partner/:partnerId/card-custom-fields",
            "params": [
              {
                "name": "partnerId",
                "value": "",
                "type": "path",
                "description": "Id of partner to retrieve custom fields for"
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query",
                "description": "Statuses of the card custom field keys to be retrieved. If omitted default statuses 'ASSIGNED' and 'AVAILABLE' will be applied."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of page to fetch"
              }
            ]
          },
          "docs": "View existing partner card custom field keys"
        },
        {
          "info": {
            "name": "View existing customer card custom field keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customer/:customerId/card-custom-fields",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "Id of customer to retrieve custom fields for"
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query",
                "description": "Statuses of the card custom field keys to be retrieved. If omitted default statuses 'ASSIGNED' and 'AVAILABLE' will be applied."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of page to fetch"
              }
            ]
          },
          "docs": "View existing customer card custom field keys"
        },
        {
          "info": {
            "name": "View the details of existing cards",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards",
            "params": [
              {
                "name": "fromCreatedDate",
                "value": "2019-03-01T01:01:01+0000",
                "type": "query",
                "description": "Cards created on or after this date. Cannot be older than 7 days. Format is `yyyy-MM-dd'T'HH:mm:ss` with zero offset from UTC. Required if toCreatedDate is supplied."
              },
              {
                "name": "toCreatedDate",
                "value": "2019-03-01T01:01:01+0000",
                "type": "query",
                "description": "Cards created on or before this date. Format is `yyyy-MM-dd'T'HH:mm:ss` with zero offset from UTC. Optional if fromCreatedDate is supplied."
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query",
                "description": "Statuses of cards to be retrieved"
              },
              {
                "name": "id",
                "value": "V000000001",
                "type": "query",
                "description": "The ID of the card to view."
              },
              {
                "name": "accountId",
                "value": "A0000001",
                "type": "query",
                "description": "The ID of account to retrieve cards for."
              },
              {
                "name": "externalRef",
                "value": "ExampleCardRef123",
                "type": "query",
                "description": "The client reference of the card to retrieve."
              },
              {
                "name": "customerId",
                "value": "C0000001",
                "type": "query",
                "description": "The ID of the customer to retrieve cards for."
              },
              {
                "name": "currency",
                "value": "GBP",
                "type": "query",
                "description": "Currency to get cards for. Expected ISO Standard currency name i.e. GBP, EUR etc"
              },
              {
                "name": "customFieldKey",
                "value": "BookingReference",
                "type": "query",
                "description": "Custom Field Key to get cards for"
              },
              {
                "name": "customFieldValue",
                "value": "Booking123",
                "type": "query",
                "description": "Custom Field Value corresponding to the custom field key to get cards for"
              },
              {
                "name": "accountIds",
                "value": "A0000001",
                "type": "query",
                "description": "Set of account Ids to retrieve cards for."
              },
              {
                "name": "channelManagerId",
                "value": "M883412312",
                "type": "query",
                "description": "The Id of the Channel manager"
              },
              {
                "name": "frequencyUsage",
                "value": "",
                "type": "query",
                "description": "How many times a card can be authorised against. This parameter is rejected for physical cards"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of page to fetch"
              }
            ]
          },
          "docs": "View the details of existing cards"
        },
        {
          "info": {
            "name": "Get card tokens",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/tokens",
            "params": [
              {
                "name": "cardId",
                "value": "V110000001",
                "type": "path",
                "description": "Card ID"
              },
              {
                "name": "includeDeletedDevices",
                "value": "true",
                "type": "query",
                "description": "Include deleted devices in results"
              }
            ]
          },
          "docs": "Retrieves all payment card tokens for the given card"
        },
        {
          "info": {
            "name": "Retrieve secure card details (PAN + CVV + PIN)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/secure-details"
          },
          "docs": "Receives the secure card details token as a parameter. This call is meant to be done from the cardholder device and not directly by the partner"
        },
        {
          "info": {
            "name": "Get card token OTP details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/card-tokens/:tokenId/otp",
            "params": [
              {
                "name": "tokenId",
                "value": "T110000001",
                "type": "path",
                "description": "Card token ID"
              }
            ]
          },
          "docs": "Retrieves the OTP details given the corresponding card token ID"
        },
        {
          "info": {
            "name": "Retrieve card reports",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/card-reports",
            "params": [
              {
                "name": "fromReportDate",
                "value": "2023-01-01",
                "type": "query",
                "description": "Retrieve reports equal to or after this date"
              },
              {
                "name": "toReportDate",
                "value": "2023-01-30",
                "type": "query",
                "description": "Retrieve reports equal to or before this date"
              },
              {
                "name": "reportTypes",
                "value": "DAILY_CARD_ACTIVITY",
                "type": "query",
                "description": "Report types"
              },
              {
                "name": "reportSubjectIds",
                "value": "C1000001",
                "type": "query",
                "description": "Report subject Ids (Customer BID, Partner BID or Channel Manager BID)"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "The size of the page(s)"
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieve card reports"
        },
        {
          "info": {
            "name": "Download a specific card report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/card-reports/:reportId/report",
            "params": [
              {
                "name": "reportId",
                "value": "",
                "type": "path",
                "description": "ID of the report to retrieve"
              }
            ]
          },
          "docs": "Download a specific card report"
        },
        {
          "info": {
            "name": "Download a specific card report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/card-reports/:reportId/download",
            "params": [
              {
                "name": "reportId",
                "value": "",
                "type": "path",
                "description": "ID of the report to download"
              }
            ]
          },
          "docs": "Download a specific card report"
        },
        {
          "info": {
            "name": "View activities for specific cards or over a date range",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/activities",
            "params": [
              {
                "name": "fromCreatedDate",
                "value": "2019-01-01T15:14:38-0000",
                "type": "query",
                "description": "Activities with a created date equal to or after this date. Format: 'yyyy-MM-dd'T'HH:mm:ssZ'. Value cannot be more than 7 days in the past when mandatory. Value is optional if only a single Card ID has been provided"
              },
              {
                "name": "toCreatedDate",
                "value": "2019-01-01T15:14:38-0000",
                "type": "query",
                "description": "Activities with a created date before this date. Format: 'yyyy-MM-dd'T'HH:mm:ssZ'. Value is optional if only a single Card ID has been provided or from date is within last 7 days"
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query",
                "description": "Activities with possibly multiple statuses equal to this value. Omitting this is equivalent to supplying all values"
              },
              {
                "name": "types",
                "value": "",
                "type": "query",
                "description": "Activities with possibly multiple types equal to this value. Omitting this is equivalent to supplying all values"
              },
              {
                "name": "cards",
                "value": "",
                "type": "query",
                "description": "Activities with possibly multiple card IDs equal to this value. Only one of 'cards' or 'accounts' must be supplied"
              },
              {
                "name": "accounts",
                "value": "",
                "type": "query",
                "description": "Activities with possibly multiple account IDs equal to this value. Only one of 'cards' or 'accounts' must be supplied"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Activities with the specified IDs. Only 'page' and/or 'size' may be used in conjunction with this filter."
              },
              {
                "name": "orderId",
                "value": "",
                "type": "query",
                "description": "Activites with specified Order Id"
              },
              {
                "name": "channelManagerId",
                "value": "",
                "type": "query",
                "description": "Id of channel manager to return activities for"
              },
              {
                "name": "sortFields",
                "value": "",
                "type": "query",
                "description": "A list of fields to sort the response by. Sorting will be applied in the order the fields are given"
              },
              {
                "name": "sortOrders",
                "value": "",
                "type": "query",
                "description": "A list of orders to apply to the respective sortFields. The only accepted sortOrders will be ASC and DESC (case insensitive)"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of page to fetch"
              }
            ]
          },
          "docs": "View activities for a specified list of cards and a given time frame. View activities for all cards belonging to a specified list of accounts and a given time frame. View all activities for a single card when a single card ID is specified, time frame is optional."
        },
        {
          "info": {
            "name": "Delete partner custom field key",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/partner/:partnerId/card-custom-fields/:key",
            "params": [
              {
                "name": "partnerId",
                "value": "",
                "type": "path",
                "description": "Id of partner to delete custom field for"
              },
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Key of the field to delete"
              }
            ]
          },
          "docs": "Delete partner custom field key"
        },
        {
          "info": {
            "name": "Delete customer custom field key",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customer/:customerId/card-custom-fields/:key",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "Id of customer to delete custom field for"
              },
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Key of the field to delete"
              }
            ]
          },
          "docs": "Delete customer custom field key"
        },
        {
          "info": {
            "name": "Delete card custom field",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/custom-fields/:key",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "Id of card the custom field should be deleted for"
              },
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Key of the key value pair of custom field that should be removed for the card"
              }
            ]
          },
          "docs": "Delete card custom field"
        }
      ]
    },
    {
      "info": {
        "name": "Restricted",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "[Restricted] Unsuspend a card",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/unsuspend",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card which should no longer be suspended"
              }
            ]
          },
          "docs": "Restores a previously suspended card to the status it was in prior to being suspended as applied by the issuer or program manager.\nUse of this endpoint is `Restricted`, depending on access being granted through contractual setup with Modulr."
        },
        {
          "info": {
            "name": "[Restricted] Suspend an existing card",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/cards/:cardId/suspend",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card which should be suspended"
              }
            ]
          },
          "docs": "Suspends a card to temporarily prevent any new authorisations as applied by the issuer or the program manager (i.e. not cardholder elective). This means that all new authorisations will be immediately declined. Outstanding authorisations are unaffected and settlement, chargebacks, refunds, etc will continue to function as normal.\nUse of this endpoint is `Restricted`, depending on access being granted through contractual setup with Modulr."
        },
        {
          "info": {
            "name": "[Restricted] Expire an existing authorisation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/authorisations/:authId/expire",
            "params": [
              {
                "name": "authId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "[Restricted] Expire an existing authorisation. Note: CREDIT_AUTH and CREDIT_AUTH_REV activities cannot be expired via this endpoint."
        }
      ]
    },
    {
      "info": {
        "name": "Cards Bulk Operations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List active bulk card requests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/bulk-cards",
            "params": [
              {
                "name": "page",
                "value": "0",
                "type": "query",
                "description": "Page to retrieve (0 indexed)"
              },
              {
                "name": "size",
                "value": "500",
                "type": "query",
                "description": "Page size"
              }
            ]
          },
          "docs": "Retrieve non-terminated (not processed/archived/deleted) bulk card requests for current user"
        },
        {
          "info": {
            "name": "Submit bulk cards operations",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/bulk-cards",
            "params": [
              {
                "name": "validateOnly",
                "value": "",
                "type": "query",
                "description": "Flag of whether to validate batch entries and not submit for processing. Default false."
              },
              {
                "name": "keepOperations",
                "value": "",
                "type": "query",
                "description": "Flag of whether to persist operations for batch request. Can only be true if validateOnly is true, default is false."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Send Card details for Create/Update/Cancel/Patch Cards in bulk. Processing part will be asynchronous"
        },
        {
          "info": {
            "name": "Upload CSV file with bulk card operations",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/bulk-cards/upload",
            "params": [
              {
                "name": "validateOnly",
                "value": "",
                "type": "query",
                "description": "Flag of whether to validate batch entries and not submit for processing. Default false."
              },
              {
                "name": "keepEntries",
                "value": "",
                "type": "query",
                "description": "Flag of whether to persist entries for batch request. Can only be true if validateOnly is true, default is false"
              },
              {
                "name": "overrideFile",
                "value": "",
                "type": "query",
                "description": "Flag of whether to replace existing file with same name. Default false."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Allow clients to upload csv file with create, update and change card status requests"
        },
        {
          "info": {
            "name": "Get bulk cards by id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/bulk-cards/:bulkRequestId",
            "params": [
              {
                "name": "bulkRequestId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get all batch specific information"
        },
        {
          "info": {
            "name": "Mark bulk request as deleted",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/bulk-cards/:bulkRequestId",
            "params": [
              {
                "name": "bulkRequestId",
                "value": "",
                "type": "path",
                "description": "Business id of bulk request to mark as deleted"
              }
            ]
          },
          "docs": "Allows client to mark bulk request as deleted if not already processed, processed with errors or archived"
        }
      ]
    },
    {
      "info": {
        "name": "Async",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get tasks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/card-tasks",
            "params": [
              {
                "name": "id",
                "value": "T000000001",
                "type": "query",
                "description": "The ID of the card task"
              },
              {
                "name": "aid",
                "value": "A0000001",
                "type": "query",
                "description": "The account ID to retrieve card tasks for"
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query",
                "description": "Statuses of card tasks to be retrieved"
              },
              {
                "name": "types",
                "value": "",
                "type": "query",
                "description": "Types of card tasks to be retrieved"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of page to fetch"
              }
            ]
          },
          "docs": "View the details of card tasks.  Ordered by createdDate, with the newest entries appearing first"
        },
        {
          "info": {
            "name": "Get a card task",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/card-tasks/:taskId",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path",
                "description": "The ID of the card task"
              }
            ]
          },
          "docs": "Retrieve the card task. If the task is complete, the resource URL will be provided to allow client to fetch the completed resource."
        },
        {
          "info": {
            "name": "Get physical card create tasks by account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/accounts/:accountId/physical-card-request-tasks",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "The account ID to retrieve create physical card tasks for"
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query",
                "description": "Statuses of tasks to be retrieved"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of page to fetch"
              }
            ]
          },
          "docs": "View the details of create physical card tasks by account.  Ordered by createdDate, with the newest entries appearing first"
        }
      ]
    },
    {
      "info": {
        "name": "Direct Debit Outbound Mandate Operations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Reject Collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/directdebits/reject",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Reject Collection"
        },
        {
          "info": {
            "name": "Cancel a specific Mandate",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/directdebits/cancel",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Used to request the cancellation of a Mandate."
        },
        {
          "info": {
            "name": "Retrieve all Mandates for an account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/directdebits/enquire/:accountId",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "Account Id"
              }
            ]
          },
          "docs": "Used to get all the Mandates for a specific account."
        }
      ]
    },
    {
      "info": {
        "name": "File Upload",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Upload payment file and store valid payments",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/payment-files",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Uploads the payment file and store the valid files extracted payments for later creating payments"
        },
        {
          "info": {
            "name": "Create payments from an uploaded file",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/payment-files/:fileId/proceed",
            "params": [
              {
                "name": "fileId",
                "value": "",
                "type": "path",
                "description": "Payment File ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a batch payment request from a valid upload file and send for processing to the payment service"
        },
        {
          "info": {
            "name": "Create payments from one or more uploaded files",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/payment-files/proceed",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create batch payment requests from valid upload files with a single applicable MFA challenge and send for processing to the payment service"
        },
        {
          "info": {
            "name": "Get an upload file latest status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/payment-files/:fileId",
            "params": [
              {
                "name": "fileId",
                "value": "",
                "type": "path",
                "description": "Payment File ID"
              }
            ]
          },
          "docs": "Get latest status of an uploaded payment file"
        },
        {
          "info": {
            "name": "Get paginated summaries of child file uploads",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/payment-files/:fileId/summaries",
            "params": [
              {
                "name": "fileId",
                "value": "",
                "type": "path",
                "description": "Payment File ID"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Page size (max 500)"
              }
            ]
          },
          "docs": "Returns a paginated list of child file upload summaries for a delegate payment file. For delegate users the fileId is the parent bid; for regular users it is the file bid."
        }
      ]
    },
    {
      "info": {
        "name": "Confirmation of Payee",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create an account name check",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/account-name-check",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows you to check the account details of a payee with their bank before you create a beneficiary or payment. If the account details are confirmed, you will have greater assurance that a payment you create will reach the correct bank account.\nThis endpoint does not support idempotent requests. Any requests containing an x-mod-nonce header used by a previous request will return the response <code>403: Forbidden (\"Unique/allowed nonce header not found\")</code>"
        },
        {
          "info": {
            "name": "Create an account name check for Direct Debit Payer",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/account-name-check/payer",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Payer Name Verification (PNV) automatically checks that your payer’s name matches the name on the bank account details submitted when setting up BACS Direct Debits. This reduces your exposure to fraud and failed payment setups\nThis endpoint does not support idempotent requests. Any requests containing an x-mod-nonce header used by a previous request will return the response <code>403: Forbidden (\"Unique/allowed nonce header not found\")</code>"
        },
        {
          "info": {
            "name": "Get SRD Accounts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/account-name-check/srd-accounts",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of Page to fetch"
              }
            ]
          },
          "docs": "Returns a list of all sort codes and account numbers for which Secondary Reference Data must be provided with all account name check requests."
        }
      ]
    },
    {
      "info": {
        "name": "Integration Notification",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a specific Webhook Notification Subscription for a Customer using the Notification ID.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/integration-notifications/:notificationId",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path"
              },
              {
                "name": "notificationId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve a specific Webhook Notification Subscription for a Customer using the Notification ID."
        },
        {
          "info": {
            "name": "Update a specific Webhook Notification Subscription for a Customer.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/integration-notifications/:notificationId",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path"
              },
              {
                "name": "notificationId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a specific Webhook Notification Subscription for a Customer."
        },
        {
          "info": {
            "name": "Delete a Webhook Notification Subscription for a Customer using the Notification ID.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/integration-notifications/:notificationId",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path"
              },
              {
                "name": "notificationId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a Webhook Notification Subscription for a Customer using the Notification ID."
        },
        {
          "info": {
            "name": "Retrieve all Webhook Notification Subscriptions for a Customer.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/integration-notifications",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "size",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieve all Webhook Notification Subscriptions for a Customer."
        },
        {
          "info": {
            "name": "Set up a new Webhook Notification Subscription for a Customer.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/integration-notifications",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set up a new Webhook Notification Subscription for a Customer."
        },
        {
          "info": {
            "name": "Retrieve failed Webhook Notifications for a Webhook using the Notification ID.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/integration-notification-webhooks/:notificationId/failures",
            "params": [
              {
                "name": "notificationId",
                "value": "",
                "type": "path",
                "description": "Id of notification"
              },
              {
                "name": "fromDateTime",
                "value": "",
                "type": "query",
                "description": "Failed since Date. Needs to be urlEncoded value"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "size",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieve failed Webhook Notifications for a Webhook using the Notification ID."
        }
      ]
    },
    {
      "info": {
        "name": "Variable Recurring Payments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Initiate a Variable Recurring Payment.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/vrp",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiates a new Variable Recurring Payment using an existing authorised consent."
        },
        {
          "info": {
            "name": "Create a VRP consent",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/vrp-consents",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a Variable Recurring Payment (VRP) consent for authorisation by the payment service user. The consent can then be used to initiate one or more payments within the payment constraints specified."
        },
        {
          "info": {
            "name": "Confirm the availability of funds in an account.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/vrp-consents/:consentId/funds-confirmation",
            "params": [
              {
                "name": "consentId",
                "value": "",
                "type": "path",
                "description": "Vrp consent id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Confirm the availability of funds in account, prior to initiating a Variable Recurring Payment, using an authorised consent."
        },
        {
          "info": {
            "name": "Get Variable Recurring Payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/vrp/:vrpPaymentId",
            "params": [
              {
                "name": "vrpPaymentId",
                "value": "",
                "type": "path",
                "description": "Vrp Payment Id"
              }
            ]
          },
          "docs": "Fetch the details of a payment initiated using Variable Recurring Payment (VRP) based on a unique payment ID."
        },
        {
          "info": {
            "name": "Get VRP consent.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/vrp-consents/:consentId",
            "params": [
              {
                "name": "consentId",
                "value": "",
                "type": "path",
                "description": "Vrp consent id"
              }
            ]
          },
          "docs": "Returns information about a given Variable Recurring Payment consent."
        },
        {
          "info": {
            "name": "Revoke a VRP consent.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/vrp-consents/:consentId",
            "params": [
              {
                "name": "consentId",
                "value": "",
                "type": "path",
                "description": "Vrp consent id"
              }
            ]
          },
          "docs": "Cancels a VRP consent and stops further variable recurring payments being made using it."
        }
      ]
    },
    {
      "info": {
        "name": "Payment Initiations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Initiate standing order from ASPSP",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/standing-order-initiations",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiate a new standing order to the specified destination account from an account held at an ASPSP."
        },
        {
          "info": {
            "name": "Initiate payment from ASPSP",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/payment-initiations",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiate a payment to the specified destination account from an account held at an ASPSP."
        },
        {
          "info": {
            "name": "Get standing order initiation request details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/standing-order-initiations/:standingOrderInitiationId",
            "params": [
              {
                "name": "standingOrderInitiationId",
                "value": "",
                "type": "path",
                "description": "Standing order initiation ID"
              }
            ]
          },
          "docs": "Retrieve the details of a specific standing order initiation request."
        },
        {
          "info": {
            "name": "Get payment initiation request details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/payment-initiations/:paymentInitiationId",
            "params": [
              {
                "name": "paymentInitiationId",
                "value": "",
                "type": "path",
                "description": "Payment initiation ID"
              }
            ]
          },
          "docs": "Retrieve the details of a specific payment initiation request."
        },
        {
          "info": {
            "name": "Get supported ASPSPs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/aspsps"
          },
          "docs": "Gets a list of all supported Account Servicing Payment Service Providers (ASPSPs)."
        }
      ]
    },
    {
      "info": {
        "name": "Document",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Uploads and stores document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/documents",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Uploads and stores document in a repository. Gives back Url encoded document path in the repository"
        },
        {
          "info": {
            "name": "Uploads and stores documents associated with an existing customer record",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/customers/:customerId/documents",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Upload and store documents related to an existing customer, typically those collected during Know Your Customer (KYC) or Know Your Business (KYB) verification processes"
        }
      ]
    },
    {
      "info": {
        "name": "Channel Manager Webhook Notifications",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve Webhook notification configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/channel-managers/webhook-notifications",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "size",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieve Webhook notification configurations for the authenticated Channel Manager"
        },
        {
          "info": {
            "name": "Create a Webhook notification configuration",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/channel-managers/webhook-notifications",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a Webhook notification configuration for the authenticated Channel Manager"
        },
        {
          "info": {
            "name": "Retrieve Webhook notification configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/channel-managers/webhook-notifications/:notificationId",
            "params": [
              {
                "name": "notificationId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve a Webhook notification configuration for the authenticated Channel Manager"
        },
        {
          "info": {
            "name": "Update a specific Webhook notification configuration for a Channel Manager",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/channel-managers/webhook-notifications/:notificationId",
            "params": [
              {
                "name": "notificationId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a specific Webhook notification configuration for a Channel Manager. Replace operations are the only available"
        },
        {
          "info": {
            "name": "Retrieve Webhook notification configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/channel-managers/webhook-notifications/:notificationId/failures",
            "params": [
              {
                "name": "notificationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "size",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieve Webhook notification configurations for the authenticated Channel Manager"
        }
      ]
    },
    {
      "info": {
        "name": "Channel Manager Card",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Channel Manager Update card",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/channel-managers/cards/:cardId",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The card id."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a virtual card"
        },
        {
          "info": {
            "name": "Channel Manager Update card",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/channel-managers/cards/:cardId",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update card - for now, the removal of cancellationDate, authWindowStartDate and authWindowEndDate fields is the only allowed action"
        },
        {
          "info": {
            "name": "Channel Manager Replace card ",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/channel-managers/cards/:cardId/replace",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "The ID of the card"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replace a card, with a reason STOLEN, DAMAGED, LOST, RENEW"
        },
        {
          "info": {
            "name": "Channel Manager Update Card Custom Fields",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/channel-managers/cards/:cardId/custom-fields",
            "params": [
              {
                "name": "cardId",
                "value": "",
                "type": "path",
                "description": "Id of the card for which the custom fields should be updated"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replace the values of a card's custom fields if they exist or create new custom fields with the given values if they do not exist"
        },
        {
          "info": {
            "name": "Channel Manager Card enquiry",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/channel-managers/cards/enquiry",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Retrieve card details by PAN"
        },
        {
          "info": {
            "name": "Channel Manager Create card ",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/channel-managers/accounts/:accountId/cards",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "The account which card funds will be raised from."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new virtual card"
        },
        {
          "info": {
            "name": "Retrieve channel manager's cards",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/channel-managers/cards",
            "params": [
              {
                "name": "fromCreatedDate",
                "value": "2019-03-01T01:01:01+0000",
                "type": "query",
                "description": "Cards created on or after this date. Cannot be older than 7 days. Format is `yyyy-MM-dd'T'HH:mm:ss` with zero offset from UTC. Required if toCreatedDate is supplied."
              },
              {
                "name": "toCreatedDate",
                "value": "2019-03-01T01:01:01+0000",
                "type": "query",
                "description": "Cards created on or before this date. Format is `yyyy-MM-dd'T'HH:mm:ss` with zero offset from UTC. Optional if fromCreatedDate is supplied."
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query",
                "description": "Statuses of cards to be retrieved"
              },
              {
                "name": "id",
                "value": "V000000001",
                "type": "query",
                "description": "The ID of the card to view."
              },
              {
                "name": "accountId",
                "value": "A0000001",
                "type": "query",
                "description": "The ID of account to retrieve cards for."
              },
              {
                "name": "externalRef",
                "value": "ExampleCardRef123",
                "type": "query",
                "description": "The client reference of the card to retrieve."
              },
              {
                "name": "customerId",
                "value": "C0000001",
                "type": "query",
                "description": "The ID of the customer to retrieve cards for."
              },
              {
                "name": "currency",
                "value": "GBP",
                "type": "query",
                "description": "Currency to get cards for. Expected ISO Standard currency name i.e. GBP, EUR etc"
              },
              {
                "name": "customFieldKey",
                "value": "BookingReference",
                "type": "query",
                "description": "Custom Field Key to get cards for"
              },
              {
                "name": "customFieldValue",
                "value": "Booking123",
                "type": "query",
                "description": "Custom Field Value corresponding to the custom field key to get cards for"
              },
              {
                "name": "accountIds",
                "value": "A0000001",
                "type": "query",
                "description": "Set of account Ids to retrieve cards for."
              },
              {
                "name": "channelManagerId",
                "value": "M883412312",
                "type": "query",
                "description": "The Id of the Channel manager"
              },
              {
                "name": "frequencyUsage",
                "value": "",
                "type": "query",
                "description": "How many times a card can be authorised against. This parameter is rejected for physical cards"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of page to fetch"
              }
            ]
          },
          "docs": "Retrieve cards owned by the channel manager"
        },
        {
          "info": {
            "name": "Retrieve channel manager's card activities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/channel-managers/cards/activities",
            "params": [
              {
                "name": "fromCreatedDate",
                "value": "2019-01-01T15:14:38-0000",
                "type": "query",
                "description": "Activities with a created date equal to or after this date. Format: 'yyyy-MM-dd'T'HH:mm:ssZ'. Value cannot be more than 7 days in the past when mandatory. Value is optional if only a single Card ID has been provided"
              },
              {
                "name": "toCreatedDate",
                "value": "2019-01-01T15:14:38-0000",
                "type": "query",
                "description": "Activities with a created date before this date. Format: 'yyyy-MM-dd'T'HH:mm:ssZ'. Value is optional if only a single Card ID has been provided or from date is within last 7 days"
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query",
                "description": "Activities with possibly multiple statuses equal to this value. Omitting this is equivalent to supplying all values"
              },
              {
                "name": "types",
                "value": "",
                "type": "query",
                "description": "Activities with possibly multiple types equal to this value. Omitting this is equivalent to supplying all values"
              },
              {
                "name": "cards",
                "value": "",
                "type": "query",
                "description": "Activities with possibly multiple card IDs equal to this value. Only one of 'cards' or 'accounts' must be supplied"
              },
              {
                "name": "accounts",
                "value": "",
                "type": "query",
                "description": "Activities with possibly multiple account IDs equal to this value. Only one of 'cards' or 'accounts' must be supplied"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Activities with the specified IDs. Only 'page' and/or 'size' may be used in conjunction with this filter."
              },
              {
                "name": "orderId",
                "value": "",
                "type": "query",
                "description": "Activites with specified Order Id"
              },
              {
                "name": "channelManagerId",
                "value": "",
                "type": "query",
                "description": "Id of channel manager to return activities for"
              },
              {
                "name": "sortFields",
                "value": "",
                "type": "query",
                "description": "A list of fields to sort the response by. Sorting will be applied in the order the fields are given"
              },
              {
                "name": "sortOrders",
                "value": "",
                "type": "query",
                "description": "A list of orders to apply to the respective sortFields. The only accepted sortOrders will be ASC and DESC (case insensitive)"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size of page to fetch"
              }
            ]
          },
          "docs": "Retrieve card activities owned by the channel manager or over specific Date range.View card activities for a single card when a card ID is specified, time frame is optional."
        },
        {
          "info": {
            "name": "Retrieve channel manager's card reports",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/channel-managers/card-reports",
            "params": [
              {
                "name": "fromReportDate",
                "value": "2023-01-01",
                "type": "query",
                "description": "Retrieve reports equal to or after this date"
              },
              {
                "name": "toReportDate",
                "value": "2023-01-30",
                "type": "query",
                "description": "Retrieve reports equal to or before this date"
              },
              {
                "name": "reportTypes",
                "value": "DAILY_CARD_ACTIVITY",
                "type": "query",
                "description": "Report types"
              },
              {
                "name": "reportSubjectIds",
                "value": "C1000001",
                "type": "query",
                "description": "Report subject Ids (Customer BID, Partner BID or Channel Manager BID)"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page to fetch (0 indexed)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "The size of the page(s)"
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieve card reports owned by the channel manager"
        },
        {
          "info": {
            "name": "Channel Manager download a specific card report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/channel-managers/card-reports/:reportId/report",
            "params": [
              {
                "name": "reportId",
                "value": "",
                "type": "path",
                "description": "ID of the report to retrieve"
              }
            ]
          },
          "docs": "Download a specific card report"
        }
      ]
    },
    {
      "info": {
        "name": "Verification of Payee",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create Verification of Payee (VOP) request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-sandbox.modulrfinance.com/api-sandbox-token/verify-payee",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows you to get information on the accuracy of the payee details the user is going to send a payment to."
        }
      ]
    }
  ],
  "bundled": true
}