{"openapi":"3.1.0","info":{"title":"Modulr API","description":"Modulr API","license":{"name":"© Modulr Finance","url":"https://www.modulrfinance.com"},"version":"1.0"},"servers":[{"url":"https://api-sandbox.modulrfinance.com/api-sandbox-token"}],"security":[{"modulo_security":[]}],"tags":[{"name":"Accounts","description":"Operations on Accounts"},{"name":"Async","description":"Asynchronous card task operations"},{"name":"Beneficiaries","description":"Operations on Beneficiaries"},{"name":"Cards","description":"Cards API"},{"name":"Confirmation of Payee","description":"Account Name Checks"},{"name":"Customers","description":"Operations on Customers"},{"name":"Direct Debits","description":"Direct Debit operations"},{"name":"Direct Debit Outbound","description":"Direct Debit Outbound operations"},{"name":"Inbound Payments","description":"Inbound payments"},{"name":"Payments","description":"Operations on Payments"},{"name":"Rules","description":"Rules"},{"name":"Transactions","description":"Operations on Transactions"},{"name":"Document","description":"Operations on Documents"},{"name":"Access Group","description":"Operations on Access Group"},{"name":"Card Simulator","description":"Cards Simulator API"},{"name":"Channel Manager","description":"Channel Manager Operations"},{"name":"File Upload","description":"Upload payment files"},{"name":"IntegrationNotification","description":"Operations on Webhook Notifications"},{"name":"Notification","description":"Operations on Notifications"},{"name":"Restricted","description":"Restricted access API calls"},{"name":"Share secure card details","description":"Share secure card details operations"}],"paths":{"/credit-authorisations/{creditAuthId}/reverse":{"post":{"tags":["Card Simulator"],"summary":"Reverse a credit authorisation","description":"Reverse a pending credit authorisation, producing a CREDIT_AUTH_REV activity","operationId":"reverseCreditAuthorisation","parameters":[{"name":"creditAuthId","in":"path","description":"ID of the CREDIT_AUTH activity to reverse","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"X000000001"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Activity is not a CREDIT_AUTH or in PENDING status","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}},"404":{"description":"Activity not found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/settlements":{"post":{"tags":["Card Simulator"],"summary":"Create a settlement without prior authorisation","description":"Submit a settlement directly to the reconciliation pipeline without a prior authorisation","operationId":"createSettlement","parameters":[{"name":"cardId","in":"path","description":"Card ID to settle against","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"V000000001"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardsimulator.CardSettlementRequest"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}},"404":{"description":"Card not found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/refunds":{"post":{"tags":["Card Simulator"],"summary":"Create a card refund","description":"Simulate a standalone refund (credit) for a card, producing a REFUND activity","operationId":"refund","parameters":[{"name":"cardId","in":"path","description":"Card id to be refund","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"V000000001"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardsimulator.CardAuthorisationRequest"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}},"404":{"description":"Not Found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/original-credits":{"post":{"tags":["Card Simulator"],"summary":"Simulate an original credit","description":"Submit card activity of type original credit","operationId":"createOriginalCredit","parameters":[{"name":"cardId","in":"path","description":"Card ID to credit","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"V000000001"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardsimulator.CreateOriginalCreditRequest"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}},"404":{"description":"Card not found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/original-credits/{originalCreditActivityId}/reverse":{"post":{"tags":["Card Simulator"],"summary":"Reverse an original credit","description":"Reverse a previously applied original credit, producing an ORIGINAL_CREDIT_REVERSAL activity","operationId":"reverseOriginalCredit","parameters":[{"name":"cardId","in":"path","description":"Card ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"V000000001"},{"name":"originalCreditActivityId","in":"path","description":"ID of the ORIGINAL_CREDIT activity to reverse","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"X000000001"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Activity is not an ORIGINAL_CREDIT in APPLIED status","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}},"404":{"description":"Activity not found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/offline-transactions":{"post":{"tags":["Card Simulator"],"summary":"Create an offline transaction","description":"Simulate an offline transaction for a card","operationId":"createOfflineTransaction","parameters":[{"name":"cardId","in":"path","description":"Card ID to create an offline transaction for","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"V000000001"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardsimulator.CardSettlementRequest"}}},"required":true},"responses":{"201":{"description":"Created"},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}},"404":{"description":"Card not found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/expire":{"post":{"tags":["Card Simulator"],"summary":"Simulate a card expiry","description":"Simulate the GPS CARD_EXPIRY message, transitioning the card status to EXPIRED in card-service","operationId":"expireCard","parameters":[{"name":"cardId","in":"path","description":"Card ID to expire","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"V000000001"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Card is already expired","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}},"404":{"description":"Card not found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/credit-authorisations":{"post":{"tags":["Card Simulator"],"summary":"Simulate a credit authorisation","description":"Submit card activity of type credit authorisation","operationId":"createCreditAuthorisation","parameters":[{"name":"cardId","in":"path","description":"Card ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"V000000001"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardsimulator.CreateCreditAuthorisationRequest"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}},"404":{"description":"Card not found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/chargebacks":{"post":{"tags":["Card Simulator"],"summary":"Create a standalone chargeback","description":"Simulate a standalone chargeback for a card.","operationId":"createChargeback","parameters":[{"name":"cardId","in":"path","description":"Card id to chargeback","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"V000000001"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardsimulator.CardActivityRequest"}}},"required":true},"responses":{"204":{"description":"Chargeback processed"},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}},"404":{"description":"Not Found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/authorisations":{"post":{"tags":["Card Simulator"],"summary":"Create a card authorisation","description":"Create an authorisation for a card","operationId":"createAuthorisation","parameters":[{"name":"cardId","in":"path","description":"Card ID to create an authorisation for this card","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"V000000001"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardsimulator.CardAuthorisationRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardsimulator.CardAuthorisationResponse"}}}},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/activities/{settlementActivityId}/chargebacks":{"post":{"tags":["Card Simulator"],"summary":"Chargeback an existing settlement","description":"Simulate a chargeback of an existing settlement activity.","operationId":"createChargebackForSettlement","parameters":[{"name":"cardId","in":"path","description":"Card id","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"V000000001"},{"name":"settlementActivityId","in":"path","description":"Settlement activity BID to chargeback","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"X000000001"}],"responses":{"204":{"description":"Chargeback processed"},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}},"404":{"description":"The settlement activity was not found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/account-status-inquiry":{"post":{"tags":["Card Simulator"],"summary":"Perform an account status inquiry","description":"Check whether a card is eligible for transactions without reserving funds","operationId":"performAccountStatusInquiry","parameters":[{"name":"cardId","in":"path","description":"Card ID to perform the account status inquiry against","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"V000000001"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardsimulator.CardAccountStatusInquiryRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardsimulator.CardAccountStatusInquiryResponse"}}}},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}},"404":{"description":"Card not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardsimulator.CardAccountStatusInquiryResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/card-tokens/{tokenId}/devices/{deviceId}/unbind":{"post":{"tags":["Card Simulator"],"summary":"Unbind a device from a card token","description":"Simulate the removal of a device binding from a card token, marking the device as DELETED within the token record in card-service","operationId":"unbindDevice","parameters":[{"name":"tokenId","in":"path","description":"Card token ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"T110000001"},{"name":"deviceId","in":"path","description":"Device ID to unbind","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"D110000001"},{"name":"cardId","in":"query","description":"Card ID that owns the token","required":true,"style":"form","explode":true,"schema":{"type":"string"},"example":"V110000001"}],"responses":{"204":{"description":"Device unbound successfully"},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}},"404":{"description":"Token or device not found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/authorisations/{authId}/settle":{"post":{"tags":["Card Simulator"],"summary":"Settle the full or partial card authorisation","description":"Settle the full card authorisation or supply an optional settlementAmount for partial settlement.","operationId":"settleAuthorisation","parameters":[{"name":"authId","in":"path","description":"Card authorisation id","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"A00000000X"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardsimulator.CardSettlementRequest"}}}},"responses":{"204":{"description":"Settlement processed"},"400":{"description":"Validation errors or settlement amount exceeds authorised amount","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/authorisations/{authId}/reverse":{"post":{"tags":["Card Simulator"],"summary":"Reverse the card authorisation","description":"Simulate a reversal of an authorization for a card","operationId":"reverseAuthorisation","parameters":[{"name":"authId","in":"path","description":"Card authorisation id to be reversed","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"A00000000X"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cardsimulator.ReverseAuthorizationRequest"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/activities/{chargebackActivityId}/resettlement":{"post":{"tags":["Card Simulator"],"summary":"Resettlement of a chargeback","description":"Simulate a resettlement (second presentment) for an existing CHARGEBACK activity, producing a RESETTLEMENT activity.","operationId":"createResettlement","parameters":[{"name":"chargebackActivityId","in":"path","description":"ID of the CHARGEBACK activity to resettle","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"X000000001"}],"responses":{"204":{"description":"Resettlement processed"},"400":{"description":"Activity is not a CHARGEBACK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}},"404":{"description":"Chargeback activity not found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/activities/{chargebackActivityId}/chargeback-reversal":{"post":{"tags":["Card Simulator"],"summary":"Reverse a chargeback","description":"Simulate a chargeback reversal for an existing CHARGEBACK activity, producing a CHARGEBACK_REVERSAL activity.","operationId":"createChargebackReversal","parameters":[{"name":"chargebackActivityId","in":"path","description":"ID of the CHARGEBACK activity to reverse","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"X000000001"}],"responses":{"204":{"description":"Chargeback reversal processed"},"400":{"description":"Activity is not a CHARGEBACK in APPLIED status","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/cardsimulator.MessageResponse"}}}}},"404":{"description":"Chargeback activity not found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}":{"get":{"tags":["Customers"],"summary":"Retrieve a specific customer using a unique customer reference","description":"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","operationId":"getCustomer","parameters":[{"name":"customerId","in":"path","description":"ID of customer to fetch","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"statuses","in":"query","description":"Customer statuses allowed when fetching the customer","required":false,"style":"form","explode":true,"schema":{"type":"array","default":["ACTIVE"],"items":{"type":"string","enum":["ACTIVE","CLOSED","BLOCKED"]}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.Customer"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"put":{"tags":["Customers"],"summary":"Edit a specific customer using a unique customer reference","description":"  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>associate</b> can additionally be edited</li>\n      </ul>\n    </li>\n    <li> For <b>vulnerabilityReason</b> you must supply a list and to delete a list you must supply an empty list in request, not supplying a list will result in no change</li>\n  </ol>\n","operationId":"editCustomer","parameters":[{"name":"customerId","in":"path","description":"ID of customer to be edited","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"C0000000"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.UpdateCustomerRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.Customer"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"patch":{"tags":["Customers"],"summary":"Edit a customer","description":"Edit details of a particular customer using its ID as a reference. Current editable fields: complianceData","operationId":"patchCustomer","parameters":[{"name":"customerId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json-patch+json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/account.Add"},{"$ref":"#/components/schemas/account.Copy"},{"$ref":"#/components/schemas/account.Move"},{"$ref":"#/components/schemas/account.Remove"},{"$ref":"#/components/schemas/account.Replace"},{"$ref":"#/components/schemas/account.Test"}]}}}},"required":true},"responses":{"200":{"description":"Successfully updated the existing customer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.Customer"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/accounts/{accountId}":{"get":{"tags":["Accounts"],"summary":"Get an account","description":"Retrieve details of a particular account using its ID as a reference","operationId":"getAccount","parameters":[{"name":"accountId","in":"path","description":"ID of account to fetch","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"statuses","in":"query","description":"Account statuses allowed when fetching the account","required":false,"style":"form","explode":true,"schema":{"type":"array","default":["ACTIVE"],"items":{"type":"string","enum":["ACTIVE","BLOCKED","CLOSED","CLIENT_BLOCKED"]}}},{"name":"includePendingTransactions","in":"query","description":"Include all pending transactions in 'balance' field","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}},{"name":"showAvailableBalance","in":"query","description":"Show available balance","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.AccountResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"put":{"tags":["Accounts"],"summary":"Edit an account","description":"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","operationId":"editAccount","parameters":[{"name":"accountId","in":"path","description":"ID of account to be edited","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.UpdateAccountRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.AccountResponse"}}}},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/accounts/{accountId}/secured-funding":{"put":{"tags":["Accounts"],"summary":"Set the secured funding limit for an account","operationId":"updateSecuredFundingLimit","parameters":[{"name":"accountId","in":"path","description":"ID of account to set the secured funding limit","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.AccountSecuredFundingRequest"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/access-groups/{accessGroupId}/content":{"put":{"tags":["Access Group"],"summary":"Update access group","description":"The ability to update an access group's name and add or remove an account","operationId":"updateAccessGroup","parameters":[{"name":"accessGroupId","in":"path","description":"Access group ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.AccessGroupRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.AccessGroupResponse"}}}},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/beneficiaries":{"post":{"tags":["Beneficiaries"],"summary":"Create a new beneficiary for a specified customer","description":"The ability to create a new beneficiary for a customer, using their customer ID as a reference.","operationId":"createBeneficiary","parameters":[{"name":"customerId","in":"path","description":"ID of customer to create beneficiary for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.CreateBeneficiaryRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.BeneficiaryResponse"}}}},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"delete":{"tags":["Beneficiaries"],"summary":"Delete beneficiaries for a specified customer","description":"deleting beneficiaries for a customer, using their customer ID","operationId":"deleteBeneficiaries","parameters":[{"name":"customerId","in":"path","description":"ID of customer to delete beneficiaries for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"bid","in":"query","description":"ID(s) of beneficiaries to delete, must owned by customer and active","required":true,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successfully deleted single resource","content":{"application/json":{"schema":{"type":"object"}}}},"207":{"description":"Map of multiple responses for multi-request","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/accounts":{"get":{"tags":["Accounts"],"summary":"Get accounts by customer","description":"Get details of accounts belonging to a particular customer using the customer’s ID as a reference","operationId":"getAccountsByCustomer","parameters":[{"name":"customerId","in":"path","description":"ID of customer to fetch accounts for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"customerStatuses","in":"query","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/account.customerStatuses"}},{"name":"statuses","in":"query","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/account.statuses"}},{"name":"minBalance","in":"query","description":"Accounts with balance equal or more than this amount","required":false,"style":"form","explode":true,"schema":{"type":"number","description":"Accounts with balance equal or more than this amount","minimum":0}},{"name":"maxBalance","in":"query","description":"Accounts with balance equal or less than this amount","required":false,"style":"form","explode":true,"schema":{"type":"number","description":"Accounts with balance equal or less than this amount","minimum":0.01}},{"name":"fromCreatedDate","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","example":"2017-01-28T01:01:01+0000"},"example":"2017-01-28T01:01:01+0000"},{"name":"toCreatedDate","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","example":"2017-01-28T01:01:01+0000"},"example":"2017-01-28T01:01:01+0000"},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"Page to fetch (0 indexed)"}},{"name":"size","in":"query","description":"Size of Page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"Size of Page to fetch","maximum":500}},{"name":"sortField","in":"query","description":"Sort by field","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Sort by field","pattern":"(id|name|balance|externalReference|createdDate)"}},{"name":"sortOrder","in":"query","description":"Sorting order","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Sorting order","pattern":"(asc|desc)"}},{"name":"currency","in":"query","description":"The currency for getting account by currency. Expected ISO Standard currency name i.e. GBP, EUR etc","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"The currency for getting account by currency. Expected ISO Standard currency name i.e. GBP, EUR etc","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"GBP"},"example":"GBP"},{"name":"showAvailableBalance","in":"query","description":"Show available balance","required":false,"style":"form","explode":true,"schema":{"type":"boolean","description":"Show available balance"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.AccountPageResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Accounts"],"summary":"Create account by customer","description":"Creates an account for a particular customer using the customer’s ID as a reference","operationId":"createAccount","parameters":[{"name":"customerId","in":"path","description":"ID of customer to create account for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.CreateAccountRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.AccountResponse"}}}},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/accounts/{accountId}/unblock":{"post":{"tags":["Accounts"],"summary":"Unblock a specific account","description":"Using a unique reference (account ID) you can unblock an account","operationId":"unblockAccount","parameters":[{"name":"accountId","in":"path","description":"ID of account to unblock","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/accounts/{accountId}/close":{"post":{"tags":["Accounts"],"summary":"Close an account","description":"Accounts with a zero balance can be closed. The account must have a status of ACTIVE or CLIENT_BLOCKED.","operationId":"closeAccount","parameters":[{"name":"accountId","in":"path","description":"ID of account to close","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/accounts/{accountId}/block":{"post":{"tags":["Accounts"],"summary":"Block a specific account","description":"Using a unique reference (account ID) you can block an account","operationId":"blockAccount","parameters":[{"name":"accountId","in":"path","description":"ID of account to block","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/access-groups":{"get":{"tags":["Access Group"],"summary":"Get a list of access groups","description":"The ability to list all access groups for the customer","operationId":"getAccessGroups","parameters":[{"name":"ids","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"array","description":"ID of access group(s) to fetch","items":{"type":"string","example":"G0000001"},"uniqueItems":true}},{"name":"types","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"array","description":"Access group types","items":{"type":"string","description":"Access group type","enum":["SERVICE_PARTNER","SERVICE_CUSTOMER","DELEGATE","USER_DEFINED"]},"uniqueItems":true}},{"name":"statuses","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"array","description":"Access group statuses","items":{"type":"string","description":"Access group status","enum":["ACTIVE","DELETED"]},"uniqueItems":true}},{"name":"typeIds","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"array","description":"Ids of the entity implied by the type(s), e.g. the partner ID","items":{"type":"string","description":"Is of the entity implied by the type(s), e.g. the partner ID","example":"C0000001"},"uniqueItems":true}},{"name":"accountIds","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"array","description":"Account BIDs of access groups to fetch","items":{"type":"string","description":"Account BID of access groups to fetch","example":"A0000001"},"uniqueItems":true}},{"name":"accountIdSearchCriteria.matchMode","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["ALL","ANY"]}},{"name":"accountIdSearchCriteria.value","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"object"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.AccessGroupResponse"}}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Access Group"],"summary":"Create access group","description":"The ability to create a new access group","operationId":"createAccessGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.AccessGroupRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.AccessGroupResponse"}}}},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers":{"get":{"tags":["Customers"],"summary":"Retrieve customers using filters","description":"Either using unique references, such as customer ID, or filter parameters, such as verification status, get details of any customers found.","operationId":"getCustomers","parameters":[{"name":"id","in":"query","description":"ID of Customer(s) to fetch","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/account.id"}},{"name":"delegateId","in":"query","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/account.delegateId"}},{"name":"q","in":"query","description":"Query parameter. ID, name or external reference of customer to search for","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Query parameter. ID, name or external reference of customer to search for"}},{"name":"type","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","enum":["LLC","PLC","SOLETRADER","OPARTNRSHP","LPARTNRSHP","LLP","INDIVIDUAL","PCM_INDIVIDUAL","PCM_BUSINESS","TRUST","PREQUALIFIED"]}},{"name":"verificationStatus","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","enum":["UNVERIFIED","VERIFIED","EXVERIFIED","REFERRED","DECLINED","REVIEWED"]}},{"name":"fromCreatedDate","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"Page to fetch (0 indexed)","minimum":0}},{"name":"size","in":"query","description":"Size of Page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"Size of Page to fetch","exclusiveMinimum":0,"maximum":500}},{"name":"sortField","in":"query","description":"Sort by field. Sorted by createdDate if not present","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Sort by field. Sorted by createdDate if not present","pattern":"(name|createdDate|id)"}},{"name":"sortOrder","in":"query","description":"Sorting order:\n1. asc -> ascendant\n2. desc -> descendant","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Sorting order:\n1. asc -> ascendant\n2. desc -> descendant","pattern":"(asc|desc)"}},{"name":"externalRef","in":"query","description":"A list of external references to filter","required":false,"deprecated":true,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/account.externalRef"}},{"name":"externalReference","in":"query","description":"A list of external references to filter","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/account.externalReference"},"example":"externalReference[0].type"},{"name":"name.type","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","enum":["WORD_MATCH","WORD_MATCH_ALPHANUMERIC","PREFIX","SUFFIX","CONTAINS","EXACT"]}},{"name":"name.value","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"companyRegNumber","in":"query","description":"Customer registration number","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Customer registration number"}},{"name":"legalEntity","in":"query","description":"Customer legal entity","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Customer legal entity","enum":["GB","NL","IE"]}},{"name":"contractCounterparty","in":"query","description":"The Modulr business unit with which the customer has contracted","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Business unit the customer contracts with","enum":["MFBV","MFSL","MUS"]}},{"name":"addressLines","in":"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","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/account.addressLines"}},{"name":"postCode","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"postTown","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"country","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"associateSearchCriteria.firstNameInitial","in":"query","description":"Person's first name initial","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Person's first name initial","maxLength":1,"minLength":1}},{"name":"associateSearchCriteria.lastName.type","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","enum":["WORD_MATCH","WORD_MATCH_ALPHANUMERIC","PREFIX","SUFFIX","CONTAINS","EXACT"]}},{"name":"associateSearchCriteria.lastName.value","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"associateSearchCriteria.lastNamePrefix","in":"query","description":"Person's prefix","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Person's prefix"}},{"name":"associateSearchCriteria.dateOfBirth","in":"query","description":"Person's date of birth ","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date","description":"Person's date of birth "}},{"name":"associateSearchCriteria.additionalIdentifier.type","in":"query","description":"Type of additional personal identifier","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Type of additional personal identifier","enum":["BSN"]}},{"name":"associateSearchCriteria.additionalIdentifier.value","in":"query","description":"Personal identifier value","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Personal identifier value","minLength":1}},{"name":"associateTypes","in":"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","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/account.associateTypes"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.CustomerPageResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Customers"],"summary":"Create a new customer","description":"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","operationId":"createCustomer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/onboarding.CreateCustomerRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/onboarding.Customer"}}}},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/onboarding.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/beneficiaries":{"get":{"tags":["Beneficiaries"],"summary":"Retrieve beneficiaries","description":"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.","operationId":"getBeneficiaries","parameters":[{"name":"id","in":"query","description":"Id of Beneficiary(s) to fetch","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/account.id"}},{"name":"customerId","in":"query","description":"Filter by Customer Id","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Filter by Customer Id"}},{"name":"q","in":"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","required":false,"deprecated":true,"style":"form","explode":true,"schema":{"type":"string","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","in":"query","description":"Beneficiaries modified after this date time","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Beneficiaries modified after this date time"}},{"name":"hasExternalReference","in":"query","description":"Filter by existence of external reference","required":false,"style":"form","explode":true,"schema":{"type":"boolean","description":"Filter by existence of external reference"}},{"name":"externalReference","in":"query","description":"External reference for beneficiary","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"External reference for beneficiary"}},{"name":"iban","in":"query","description":"IBAN","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"IBAN"}},{"name":"abaRoutingNumber","in":"query","description":"abaRoutingNumber","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"abaRoutingNumber"}},{"name":"currency","in":"query","description":"Currency","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Currency","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},{"name":"qualifier","in":"query","description":"A list of external qualifiers","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/account.qualifier"}},{"name":"state","in":"query","description":"Approval item state(s) to filter by","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/account.state"}},{"name":"validForAccount","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","example":"A000000001"},"example":"A000000001"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Sort order","pattern":"(ASC|DESC)"}},{"name":"sortField","in":"query","description":"Sort by field, This defaults to name if not present","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Sort by field, This defaults to name if not present","pattern":"(name|createdDate)"}},{"name":"orSortCode.type","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","enum":["WORD_MATCH","WORD_MATCH_ALPHANUMERIC","PREFIX","SUFFIX","CONTAINS","EXACT"]}},{"name":"orSortCode.value","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"orAccountNumber.type","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","enum":["WORD_MATCH","WORD_MATCH_ALPHANUMERIC","PREFIX","SUFFIX","CONTAINS","EXACT"]}},{"name":"orAccountNumber.value","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"orIban.type","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","enum":["WORD_MATCH","WORD_MATCH_ALPHANUMERIC","PREFIX","SUFFIX","CONTAINS","EXACT"]}},{"name":"orIban.value","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"orAbaRoutingNumber.type","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","enum":["WORD_MATCH","WORD_MATCH_ALPHANUMERIC","PREFIX","SUFFIX","CONTAINS","EXACT"]}},{"name":"orAbaRoutingNumber.value","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"orName.type","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","enum":["WORD_MATCH","WORD_MATCH_ALPHANUMERIC","PREFIX","SUFFIX","CONTAINS","EXACT"]}},{"name":"orName.value","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"orExternalReference.type","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","enum":["WORD_MATCH","WORD_MATCH_ALPHANUMERIC","PREFIX","SUFFIX","CONTAINS","EXACT"]}},{"name":"orExternalReference.value","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"orDefaultReference.type","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","enum":["WORD_MATCH","WORD_MATCH_ALPHANUMERIC","PREFIX","SUFFIX","CONTAINS","EXACT"]}},{"name":"orDefaultReference.value","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"createdDate","in":"query","description":"Created date","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date","description":"Created date"}},{"name":"partialName","in":"query","description":"Partial name","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Partial name"}},{"name":"sortCode","in":"query","description":"Sort code","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Sort code"}},{"name":"accountNumber","in":"query","description":"Account number","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Account number"}},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"Page to fetch (0 indexed)"}},{"name":"size","in":"query","description":"Size of Page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"Size of Page to fetch","maximum":500}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.BeneficiaryPageResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/beneficiaries/{beneficiaryId}/locks":{"get":{"tags":["Beneficiaries"],"summary":"Retrieve locked beneficiary entities","description":"Fetch references of the entities (payment, rule) that have caused the beneficiary to be locked","operationId":"getLocks","parameters":[{"name":"beneficiaryId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"Page to fetch (0 indexed)","minimum":0}},{"name":"size","in":"query","description":"Size of Page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"Size of Page to fetch","maximum":500,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.BeneficiaryLockPageResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/accounts":{"get":{"tags":["Accounts"],"summary":"Get accounts using filter","description":"Gives the ability to find accounts and get their details using filters","operationId":"getAccounts","parameters":[{"name":"id","in":"query","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/account.id"}},{"name":"q","in":"query","description":"ID or name of the account to search for","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"ID or name of the account to search for"}},{"name":"identifierType","in":"query","description":"Accounts that contain this identifier type","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Accounts that contain this identifier type","enum":["SCAN","IBAN","DD","INTL"],"example":"SCAN"},"example":"SCAN"},{"name":"name.type","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","enum":["WORD_MATCH","WORD_MATCH_ALPHANUMERIC","PREFIX","SUFFIX","CONTAINS","EXACT"]}},{"name":"name.value","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"externalReference.type","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","enum":["WORD_MATCH","WORD_MATCH_ALPHANUMERIC","PREFIX","SUFFIX","CONTAINS","EXACT"]}},{"name":"externalReference.value","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"customerId","in":"query","description":"The customer ID for getting account by customer ID","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/account.customerId"},"example":"C1234567"},{"name":"accountNumber.type","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","enum":["WORD_MATCH","WORD_MATCH_ALPHANUMERIC","PREFIX","SUFFIX","CONTAINS","EXACT"]}},{"name":"accountNumber.value","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"iban.type","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","enum":["WORD_MATCH","WORD_MATCH_ALPHANUMERIC","PREFIX","SUFFIX","CONTAINS","EXACT"]}},{"name":"iban.value","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"statuses","in":"query","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/account.statuses"}},{"name":"minBalance","in":"query","description":"Accounts with balance equal or more than this amount","required":false,"style":"form","explode":true,"schema":{"type":"number","description":"Accounts with balance equal or more than this amount","minimum":0}},{"name":"maxBalance","in":"query","description":"Accounts with balance equal or less than this amount","required":false,"style":"form","explode":true,"schema":{"type":"number","description":"Accounts with balance equal or less than this amount","minimum":0.01}},{"name":"fromCreatedDate","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","example":"2017-01-28T01:01:01+0000"},"example":"2017-01-28T01:01:01+0000"},{"name":"toCreatedDate","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","example":"2017-01-28T01:01:01+0000"},"example":"2017-01-28T01:01:01+0000"},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"Page to fetch (0 indexed)"}},{"name":"size","in":"query","description":"Size of Page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"Size of Page to fetch","maximum":500}},{"name":"sortField","in":"query","description":"Sort by field","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Sort by field","pattern":"(id|name|balance|externalReference|createdDate)"}},{"name":"sortOrder","in":"query","description":"Sorting order","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Sorting order","pattern":"(asc|desc)"}},{"name":"currency","in":"query","description":"The currency for getting account by currency. Expected ISO Standard currency name i.e. GBP, EUR etc","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"The currency for getting account by currency. Expected ISO Standard currency name i.e. GBP, EUR etc","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"GBP"},"example":"GBP"},{"name":"showAvailableBalance","in":"query","description":"Show available balance","required":false,"style":"form","explode":true,"schema":{"type":"boolean","description":"Show available balance"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.AccountPageResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/accounts/{accountId}/transactions":{"get":{"tags":["Transactions"],"summary":"Get transactions for a specific Account","description":"Retrieves the last 6 months of transactions (successful payments in & out) of an account, specified by a unique account reference.","operationId":"getTransactionsByAccount","parameters":[{"name":"accountId","in":"path","description":"ID of account to fetch transactions for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"q","in":"query","description":"Partial description text to search for","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Partial description text to search for"}},{"name":"minAmount","in":"query","description":"Transactions with amount equal or more than this amount","required":false,"style":"form","explode":true,"schema":{"type":"number","description":"Transactions with amount equal or more than this amount","minimum":0}},{"name":"maxAmount","in":"query","description":"Transactions with amount equal or less than this amount","required":false,"style":"form","explode":true,"schema":{"type":"number","description":"Transactions with amount equal or less than this amount","minimum":0.01}},{"name":"fromPostedDate","in":"query","description":"Transactions with posted date equal or after to this date","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Transactions with posted date equal or after to this date"}},{"name":"toPostedDate","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"array","description":"Transaction types","items":{"type":"string","description":"Transaction type","enum":["PI_BACS","PI_BACS_CONTRA","PI_FAST","PI_CHAPS","PI_DD","PI_SECT","PI_SEPA_INST","PI_REV","PI_FAST_REV","PO_FAST","PO_CHAPS","PO_DD","PO_SECT","PO_SEPA_INST","PO_REV","INT_INTERC","INT_INTRAC","ADHOC","FE_TXN","FE_ACMNT","FE_ACOPN","FE_REV","PO_MASTER","PI_MASTER","PO_REV_MASTER","PO_VISA","PI_VISA","PI_SWIFT","PO_SWIFT","PI_DD_PEND","PO_DD_PEND","DDIC_RETURN","ARUDD_RETURN","PO_FX","PI_FX","PI_FXFEE"]}}},{"name":"credit","in":"query","description":"If true only credit transactions will be returned, if false, only debit transactions will be returned","required":false,"style":"form","explode":true,"schema":{"type":"boolean","description":"If true only credit transactions will be returned, if false, only debit transactions will be returned"}},{"name":"sourceId","in":"query","description":"Transactions with this sourceId","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Transactions with this sourceId"}},{"name":"size","in":"query","description":"Size of Page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"Size of Page to fetch","maximum":500}},{"name":"showAvailableBalance","in":"query","description":"Show available balance","required":false,"style":"form","explode":true,"schema":{"type":"boolean","description":"Show available balance"}},{"name":"fromTransactionDate","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","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","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"Page to fetch (0 indexed)"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.TransactionPageResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/access-groups/{accessGroupId}":{"get":{"tags":["Access Group"],"summary":"Get access group","description":"The ability to retrieve an access group by ID","operationId":"getAccessGroup","parameters":[{"name":"accessGroupId","in":"path","description":"Access group ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account.AccessGroupWithDetailsResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/account.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/payments":{"get":{"tags":["Payments"],"summary":"Retrieve payments","description":"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.","operationId":"getPayments","parameters":[{"name":"id","in":"query","description":"Payment ID. If specified then all other parameters are ignored. Use ids to search for multiple payment IDs","required":false,"deprecated":true,"style":"form","explode":true,"schema":{"type":"string","deprecated":true,"description":"Payment ID. If specified then all other parameters are ignored. Use ids to search for multiple payment IDs"}},{"name":"ids","in":"query","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/payment.ids"}},{"name":"fromCreatedDate","in":"query","description":"Payments created date equal or after to this date. Mandatory Parameter(except when 'id', 'ids', 'fxQuoteId' or 'modifiedSince' parameter is used)","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Payments created date equal or after to this date. Mandatory Parameter(except when 'id', 'ids', 'fxQuoteId' or 'modifiedSince' parameter is used)","example":"2016-01-01T01:01:01+0000"},"example":"2016-01-01T01:01:01+0000"},{"name":"toCreatedDate","in":"query","description":"Payments created date equal or before to this date","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Payments created date equal or before to this date"}},{"name":"modifiedSince","in":"query","description":"Payments modified date equal or before to this date","required":false,"deprecated":true,"style":"form","explode":true,"schema":{"type":"string","description":"Payments modified date equal or before to this date"}},{"name":"fromUpdatedDate","in":"query","description":"Payments updated date equal or after to this date.","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Payments updated date equal or after to this date.","example":"2016-01-01T01:01:01+0000"},"example":"2016-01-01T01:01:01+0000"},{"name":"toUpdatedDate","in":"query","description":"Payments updated date equal or before to this date.","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Payments updated date equal or before to this date.","example":"2016-01-01T01:01:01+0000"},"example":"2016-01-01T01:01:01+0000"},{"name":"sourceAccountId","in":"query","description":"The source account ID","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"The source account ID"}},{"name":"hasExternalReference","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"boolean","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","in":"query","description":"External reference can only have alphanumeric characters plus underscore, hyphen and space","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"External reference can only have alphanumeric characters plus underscore, hyphen and space","pattern":"[\\w-\\s]*"}},{"name":"status","in":"query","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/payment.status"}},{"name":"type","in":"query","description":"The payment type to search for.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"PAYOUT","description":"The payment type to search for.","enum":["PAYIN","PAYOUT","RETURN"]}},{"name":"excludeBatchPayments","in":"query","description":"Exclude payments which are part of a batch with submission type BATCH","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false,"description":"Exclude payments which are part of a batch with submission type BATCH"}},{"name":"batchPaymentId","in":"query","description":"Filter on batch","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Filter on batch"}},{"name":"reversals","in":"query","description":"Filter on reversals","required":false,"style":"form","explode":true,"schema":{"type":"boolean","description":"Filter on reversals"}},{"name":"schemeId","in":"query","description":"Filter on scheme ID","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Filter on scheme ID"}},{"name":"approvalStatus","in":"query","description":"Payment approval status, multiple statuses can be specified by repeating the parameter","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/payment.approvalStatus"}},{"name":"currency","in":"query","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/payment.currency"}},{"name":"minAmount","in":"query","description":"Payments amount equal or greater than this amount","required":false,"style":"form","explode":true,"schema":{"type":"number","description":"Payments amount equal or greater than this amount","example":5.5,"exclusiveMinimum":0},"example":5.5},{"name":"maxAmount","in":"query","description":"Payments amount equal or less than this amount","required":false,"style":"form","explode":true,"schema":{"type":"number","description":"Payments amount equal or less than this amount","example":50.5,"exclusiveMinimum":0},"example":50.5},{"name":"fromPaymentScheduledDate","in":"query","description":"Payments scheduled date equal or after to this date","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date-time","description":"Payments scheduled date equal or after to this date","example":"2022-01-01T01:01:01+0000"},"example":"2022-01-01T01:01:01+0000"},{"name":"toPaymentScheduledDate","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date-time","description":"Payments scheduled date equal or before to this date and in absence of fromPaymentDate, payments executed prior to 180 days from this date","example":"2023-01-01T01:01:01+0000"},"example":"2023-01-01T01:01:01+0000"},{"name":"customerId","in":"query","description":"Filter on customer ID","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/payment.customerId"},"example":"C1234567"},{"name":"currentUserCanApprove","in":"query","description":"Only return payments the current user can approve.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","description":"Only return payments the current user can approve.","example":true},"example":true},{"name":"sortField","in":"query","description":"Sort by field. Sorted by createdDate if not present","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Sort by field. Sorted by createdDate if not present","pattern":"(amount|createdDate|paymentScheduledDate)"}},{"name":"sortOrder","in":"query","description":"Sorting order:\n1. asc -> ascending\n2. desc -> descending","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Sorting order:\n1. asc -> ascending\n2. desc -> descending","pattern":"(asc|desc)"}},{"name":"page","in":"query","description":"The page to fetch. 0 indexed","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0,"description":"The page to fetch. 0 indexed","minimum":0}},{"name":"size","in":"query","description":"The size of the page(s)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"The size of the page(s)","minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment.PaymentPageResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/payment.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Payments"],"summary":"Create a payment","description":"Supports both Payments to external bank accounts via Faster Payments and transfers to other Modulr accounts. Requests to Payments are asynchronous.","operationId":"sendPayment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment.PaymentOutRequest"}}},"required":true},"responses":{"201":{"description":"PaymentReference","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment.PaymentResponse"}}}},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/payment.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/batchpayments":{"get":{"tags":["Payments"],"summary":"Get batch payments by a given set of parameters","description":"This endpoint allows for a user who has submitted multiple batch to use some criteria to get the batch payments.","operationId":"getBatchPayments","parameters":[{"name":"id","in":"query","description":"List of batch payment IDs","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/payment.id"}},{"name":"externalReference","in":"query","description":"Batch payments External Reference contains this text.","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Batch payments External Reference contains this text.","example":"aReference_00001","maxLength":50,"minLength":0,"pattern":"[\\w-\\s]*"},"example":"aReference_00001"},{"name":"fromCreatedDate","in":"query","description":"Batch payments created date equal or after to this date.","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date","description":"Batch payments created date equal or after to this date.","example":"2022-05-16"},"example":"2022-05-16"},{"name":"toCreatedDate","in":"query","description":"Batch payments created date equal or before this date.","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date","description":"Batch payments created date equal or before this date.","example":"2026-06-08"},"example":"2026-06-08"},{"name":"batchPaymentStatuses","in":"query","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/payment.batchPaymentStatuses"}},{"name":"paymentStatuses","in":"query","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/payment.paymentStatuses"}},{"name":"approvalStatus","in":"query","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/payment.approvalStatus"}},{"name":"currentUserCanApprove","in":"query","description":"Only return batch payments the current user can approve.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","description":"Only return batch payments the current user can approve.","example":true},"example":true},{"name":"createdByCustomerId","in":"query","description":"Limit results by the customer which created the batch payment request","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Limit results by the customer which created the batch payment request"}},{"name":"submissionType","in":"query","description":"Limit results to batches with submission type specified","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Limit results to batches with submission type specified","enum":["BATCH","BULK"]}},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0,"description":"Page to fetch (0 indexed)"}},{"name":"size","in":"query","description":"Size of Page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":20,"description":"Size of Page to fetch","maximum":500}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment.BatchPaymentsResponse"}}}},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/payment.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Payments"],"summary":"Make a batch payment","description":"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.","operationId":"submitBatchPayments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment.BatchPaymentOutRequest"}}},"required":true},"responses":{"201":{"description":"BatchPaymentReference","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment.BatchPaymentDetailsResponse"}}}},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/payment.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/batchpayments/{batchPaymentId}/cancel":{"post":{"tags":["Payments"],"summary":"Cancel the batch payment","description":"Cancels a batch payment request if it is not already processed","operationId":"cancelBatchPayments","parameters":[{"name":"batchPaymentId","in":"path","description":"Batch payment request id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/payment.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/batchpayments/{id}":{"get":{"tags":["Payments"],"summary":"Get batch payment by ID","description":"Get the details of an existing batch payment by ID","operationId":"getBatchPayment","parameters":[{"name":"id","in":"path","description":"id given when batch request was made","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment.BatchPaymentDetailsResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/payment.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/rules/{ruleId}":{"put":{"tags":["Rules"],"summary":"Edit a specific Rule","description":"The ability to modify the details of a specific rule based on the rule's unique reference.","operationId":"modifyRule","parameters":[{"name":"ruleId","in":"path","description":"Id of Rule to be edited","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule.CreateRuleRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule.RuleResponse"}}}},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/rule.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/rules":{"post":{"tags":["Rules"],"summary":"Create a Rule","description":"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","operationId":"createRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule.CreateRuleRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule.RuleResponse"}}}},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/rule.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"delete":{"tags":["Rules"],"summary":"Delete a Rule","description":"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.","operationId":"removeRules","parameters":[{"name":"rIds","in":"query","description":"Id(s) of Rules to delete","required":true,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successfully deleted single resource","content":{"application/json":{"schema":{"type":"object"}}}},"207":{"description":"Map of multiple responses for multi-request","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/rule.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/accounts/{id}/rules":{"get":{"tags":["Rules"],"summary":"Get all Rules for a specific Account","description":"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.","operationId":"getRules","parameters":[{"name":"id","in":"path","description":"Account ID of the rules","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"Size of Page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":20}},{"name":"rtype","in":"query","description":"Filter to a specific RuleType","required":false,"style":"form","explode":true,"schema":{"type":"string","default":""},"example":"SPLIT, SWEEP, FUNDING"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule.RulePageResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/rule.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/accounts/{id}/rules/{rtype}":{"get":{"tags":["Rules"],"summary":"Retrieve a Rule by rule type on a specific account","description":"You need to know the unique reference of the account and the rule type you want to get to information on.","operationId":"getRule","parameters":[{"name":"id","in":"path","description":"Account ID of the rule","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"rtype","in":"path","description":"The type of Rule.","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"SPLIT, SWEEP, FUNDING"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule.RuleResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/rule.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/partners/{partnerId}/notifications/{notificationId}":{"get":{"tags":["Notification"],"summary":"Retrieve a specific notification by unique reference for a specific partner","description":"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.","operationId":"getPartnerNotification","parameters":[{"name":"partnerId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"notificationId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification.NotificationResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/notification.MessageResponse"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification.NotificationResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"put":{"tags":["Notification"],"summary":"Update a specific notification by unique reference for a specific partner","description":"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.","operationId":"editPartnerNotification","parameters":[{"name":"partnerId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"notificationId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification.UpdateNotificationRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification.NotificationResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/notification.MessageResponse"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification.NotificationResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/notifications/{notificationId}":{"get":{"tags":["Notification"],"summary":"Retrieve a specific notification by unique reference for a specific customer","description":"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.","operationId":"getCustomerNotification","parameters":[{"name":"customerId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"notificationId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification.NotificationResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/notification.MessageResponse"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification.NotificationResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"put":{"tags":["Notification"],"summary":"Update a specific notification by unique reference for a specific customer","description":"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.","operationId":"editCustomerNotification","parameters":[{"name":"customerId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"notificationId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification.UpdateNotificationRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification.NotificationResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/notification.MessageResponse"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification.NotificationResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/partners/{partnerId}/notifications":{"get":{"tags":["Notification"],"summary":"Get all Notifications linked directly to a Partner","description":"Retrieve details of all notifications set up for a partner using the partner's ID as a reference","operationId":"getAllPartnerNotifications","parameters":[{"name":"partnerId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/notification.NotificationResponse"}}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/notification.MessageResponse"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/notification.NotificationResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Notification"],"summary":"Set up a Notification for a Partner","description":"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","operationId":"addPartnerNotification","parameters":[{"name":"partnerId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification.NotificationRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification.NotificationResponse"}}}},"400":{"description":"Bad request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/notification.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/notifications":{"get":{"tags":["Notification"],"summary":"Get all Notifications for a Customer","description":"Retrieve details of all notifications set up for a customer using the customer's ID as a reference","operationId":"getAllCustomerNotifications","parameters":[{"name":"customerId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/notification.NotificationResponse"}}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/notification.MessageResponse"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/notification.NotificationResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Notification"],"summary":"Set up a Notification for a Customer","description":"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","operationId":"addCustomerNotification","parameters":[{"name":"customerId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification.NotificationRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/notification.NotificationResponse"}}}},"400":{"description":"Bad request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/notification.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/webhooks/{webhookId}/failures":{"get":{"tags":["Notification"],"summary":"Check if a particular webhook has failed","description":"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)","operationId":"getFailedWebHooks","parameters":[{"name":"webhookId","in":"path","description":"Id of Webhook ","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"from","in":"query","description":"Failed since Date. Needs to be urlEncoded value","required":true,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/notification.WebHookFailureResponse"}}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/notification.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/credit":{"post":{"tags":["Inbound Payments"],"summary":"Endpoint to mock the credit of an account","description":"Inbound payments - mock (Sandbox only)","operationId":"createPayments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/inboundpayment.InboundPaymentRequest"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/inboundpayment.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/mandates/{mandateId}/collectionschedules":{"post":{"tags":["Direct Debits"],"summary":"Create the collection schedule for the given mandate-id.","description":"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.","operationId":"createCollectionSchedule","parameters":[{"name":"mandateId","in":"path","description":"Id of mandate to create collection for.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/directdebit.CreateCollectionScheduleRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/directdebit.CollectionScheduleResponse"}}}},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/mandates/{mandateId}/cancel":{"post":{"tags":["Direct Debits"],"summary":"Cancel Mandate for given mandate-id.","description":"Cancel Mandate for given mandate-id.","operationId":"cancelMandate","parameters":[{"name":"mandateId","in":"path","description":"Id of Mandate to cancel.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/directdebit.CancelMandateRequest"}}},"required":true},"responses":{"200":{"description":"Mandate cancelled."},"400":{"description":"Validation errors.","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/mandates/bulk-create":{"post":{"tags":["Direct Debits"],"summary":"Bulk request of Direct Debit mandates for the given account-id.","operationId":"createBulkMandate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/directdebit.BulkCreateMandateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/directdebit.BulkCreateResponse"}}}},"400":{"description":"Validation errors.","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/mandates/bulk-cancel":{"post":{"tags":["Direct Debits"],"summary":"Bulk mandate cancellation request for the given account-id.","operationId":"cancelBulkMandate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/directdebit.BulkCancelMandateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/directdebit.BulkCancelMandateResponse"}}}},"400":{"description":"Validation errors.","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/collectionschedules/{collectionScheduleId}/cancel":{"post":{"tags":["Direct Debits"],"summary":"Cancel a Direct Debit collection schedule for the given collection-id.","operationId":"cancelCollectionSchedule","parameters":[{"name":"collectionScheduleId","in":"path","description":"Id of the collectionSchedule to cancel","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"CollectionSchedule cancelled"},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/collections/{collectionId}/cancel":{"post":{"tags":["Direct Debits"],"summary":"Cancel a Direct Debit collection for the given collection-id.","operationId":"cancelCollection","parameters":[{"name":"collectionId","in":"path","description":"Id of the collection to cancel","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Collection cancelled"},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/collection/{collectionId}/represent":{"post":{"tags":["Direct Debits"],"summary":"Represent collection for given collection id","description":"Represent collection for given collection id","operationId":"representCollection","parameters":[{"name":"collectionId","in":"path","description":"Id of collection to represent","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Collection represented"},"400":{"description":"Validation errors.","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/accounts/{accountId}/mandates":{"post":{"tags":["Direct Debits"],"summary":"Create a Direct Debit mandate for the given account-id.","description":"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.","operationId":"createMandate","parameters":[{"name":"accountId","in":"path","description":"Id of account to create Direct Debit for.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/directdebit.CreateMandateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/directdebit.Mandate"}}}},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/reconciliations":{"get":{"tags":["Direct Debits"],"summary":"Get Reconciliations based on search criteria.","description":"Use this endpoint to get a list of Reconciliations for a given account and date.","operationId":"getReconciliations","parameters":[{"name":"accountId","in":"query","description":"Id(s) of account to fetch Reconciliations for.","required":true,"style":"form","explode":true,"schema":{"type":"string","description":"Id(s) of account to fetch Reconciliations for."}},{"name":"collectionDate","in":"query","description":"Reconciliation entry for date.","required":true,"style":"form","explode":true,"schema":{"type":"string","format":"date","description":"Reconciliation entry for date."}},{"name":"sortField","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","pattern":"(id|createdDate)"}},{"name":"sortOrder","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","pattern":"(asc|desc)"}},{"name":"size","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","maximum":500}},{"name":"page","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/directdebit.ReconciliationPageResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/mandates":{"get":{"tags":["Direct Debits"],"summary":"Get Mandates based on search criteria.","description":"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...","operationId":"getMandates","parameters":[{"name":"id","in":"query","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/directdebit.id"}},{"name":"accountId","in":"query","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/directdebit.accountId"}},{"name":"q","in":"query","description":"Query parameter. ID, name or reference of mandate to search for","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Query parameter. ID, name or reference of mandate to search for"}},{"name":"fromCreatedDate","in":"query","description":"Mandates created on or after this date.","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Mandates created on or after this date."}},{"name":"toCreatedDate","in":"query","description":"Mandates created on or before this date.","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Mandates created on or before this date."}},{"name":"fromSubmittedDate","in":"query","description":"Mandates submitted on or after this date.","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Mandates submitted on or after this date."}},{"name":"toSubmittedDate","in":"query","description":"Mandates submitted on or before this date.","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Mandates submitted on or before this date."}},{"name":"status","in":"query","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/directdebit.status"}},{"name":"name","in":"query","description":"Account Name on the Mandate","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Account Name on the Mandate"}},{"name":"reference","in":"query","description":"reference of the Mandate","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"reference of the Mandate"}},{"name":"externalReference","in":"query","description":"externalReference of the Mandate","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"externalReference of the Mandate"}},{"name":"bulkCreateRequestId","in":"query","description":"Bulk create request ID","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Bulk create request ID"}},{"name":"bulkCancelRequestId","in":"query","description":"Bulk cancel request ID","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Bulk cancel request ID"}},{"name":"sortField","in":"query","description":"Sort by field","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Sort by field","pattern":"id|createdDate|submittedDate|status|name|reference|externalReference"}},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Sort order","enum":["ASC","DESC"],"example":"asc"},"example":"asc"},{"name":"page","in":"query","description":"Page to fetch (zero-indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"Page to fetch (zero-indexed)","minimum":0}},{"name":"size","in":"query","description":"Size of page to fetch.","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"Size of page to fetch.","exclusiveMinimum":0,"maximum":500}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/directdebit.MandatePageResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/indemnity-claims":{"get":{"tags":["Direct Debits"],"summary":"Get Indemnity Claims based on search criteria","description":"Returns a list of Indemnity Claim Advice's based on the parameters provided.","operationId":"getIndemnityClaims","parameters":[{"name":"accountId","in":"query","description":"Collection Account Id","required":true,"style":"form","explode":true,"schema":{"type":"string","description":"Collection Account Id"}},{"name":"indemnityClaimIds","in":"query","description":"List of Indemnity Claim Id's","required":false,"style":"form","explode":true,"schema":{"type":"array","description":"List of Indemnity Claim Id's","example":"ICC1234567","items":{"type":"string","description":"List of Indemnity Claim Id's","example":"ICC1234567"}},"example":"ICC1234567"},{"name":"ddicReferences","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"array","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","example":"DDICreference","items":{"type":"string","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","example":"DDICreference"}},"example":"DDICreference"},{"name":"serviceUserReferences","in":"query","description":"List of mandate/ddi references that claims are related to.","required":false,"style":"form","explode":true,"schema":{"type":"array","description":"List of mandate/ddi references that claims are related to.","items":{"type":"string","description":"List of mandate/ddi references that claims are related to."}}},{"name":"statuses","in":"query","description":"List of statuses that claims are in.","required":false,"style":"form","explode":true,"schema":{"type":"array","description":"List of statuses that claims are in.","items":{"type":"string","description":"List of statuses that claims are in.","enum":["NEW","CANCELLED","SETTLED"]}}},{"name":"sortField","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","pattern":"(id|createdDate)"}},{"name":"sortOrder","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","pattern":"(asc|desc)"}},{"name":"size","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","maximum":500}},{"name":"page","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/directdebit.IndemnityClaimPageResponse"}}}},"400":{"description":"Validation Errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/indemnity-claims/{indemnityClaimId}":{"get":{"tags":["Direct Debits"],"summary":"Get an Indemnity Claim for a given id","description":"Returns a singular Indemnity Claim based on the ID supplied in the path.","operationId":"getIndemnityClaim","parameters":[{"name":"indemnityClaimId","in":"path","description":"Id of the indemnityClaim","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/directdebit.IndemnityClaimResponse"}}}},"400":{"description":"Validation Errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}},"404":{"description":"No Indemnity Claim found matching that ID","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/collectionschedules":{"get":{"tags":["Direct Debits"],"summary":"Get all collectionschedules for a mandate","description":"By supplying the mandate id you can view all information regarding the collection schedules linked to that mandate.","operationId":"getCollectionSchedules","parameters":[{"name":"mandateId","in":"query","description":"Mandate Id to fetch collections for.","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"sortField","in":"query","description":"Sort by field","required":false,"style":"form","explode":true,"schema":{"type":"string","pattern":"id|createdDate|payment|status|externalReference"}},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"style":"form","explode":true,"schema":{"type":"string","pattern":"asc|desc"}},{"name":"page","in":"query","description":"Page to fetch (zero-indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"Size of page to fetch.","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":20,"maximum":500}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/directdebit.DirectDebitPageResponseCollectionScheduleResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/collections":{"get":{"tags":["Direct Debits"],"summary":"Get all collection activities of an account","description":"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","operationId":"getCollections","parameters":[{"name":"accountId","in":"query","description":"Account Id to fetch collections items for.","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"mandateId","in":"query","description":"Id of mandate whose the collection to fetch.","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"type of collection to fetch","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Collection activities happened on or after this date","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"endDate","in":"query","description":"Collection item activities happened on or before this date","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"sortOrder","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","pattern":"(asc|desc)"}},{"name":"sortField","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","pattern":"(id|createdDate|activityDate)"}},{"name":"page","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","maximum":500}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/directdebit.DirectDebitPageResponseCollection"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/share-secure-details/{shareSecureDetailsId}":{"get":{"tags":["Share secure card details"],"summary":"Retrieve a single share secure card details record","description":"This endpoint retrieves a specific share secure card details record for a given card and share details token id","operationId":"getShareSecureCardDetailsById","parameters":[{"name":"cardId","in":"path","description":"The ID of the card to retrieve the share secure card details for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"shareSecureDetailsId","in":"path","description":"The id of the token whose share secure card details is being retrieved","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"includeActivity","in":"query","description":"Flag whether to include the activities of the token","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.ShareSecureCardDetailSummaryResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Invalid permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.ShareSecureCardDetailSummaryResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"put":{"tags":["Share secure card details"],"summary":"Update share secure details","description":"This endpoints allows updating the share secure card details","operationId":"updateShareSecureDetails","parameters":[{"name":"cardId","in":"path","description":"The ID of the card to update share secure card details for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"shareSecureDetailsId","in":"path","description":"The ID of the share secure card details to update","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.UpdateShareSecureDetailsRequest"}}},"required":true},"responses":{"204":{"description":"Share secure card details successfully updated"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Invalid permissions"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/authentication":{"put":{"tags":["Cards"],"summary":"Update card authentication","description":"Support knowledge based authentication (KBA)","operationId":"updateCardAuthentication","parameters":[{"name":"cardId","in":"path","description":"The ID of the card which has authentication information to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.UpdateCardAuthenticationRequest"}}},"required":true},"responses":{"204":{"description":"Card authentication updated"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/partners/{partnerId}/card-report-types/{reportType}/notifications":{"get":{"tags":["Cards"],"summary":"Retrieve card report type notification configuration for partner","operationId":"getNotificationConfigurationsForAGivenPartnerAndReportType","parameters":[{"name":"partnerId","in":"path","description":"Id of partner to retrieve report type notification configuration for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"reportType","in":"path","description":"Type of report partner wants to retrieve notification configuration for","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["DAILY_CARD_ACTIVITY","MONTHLY_CARD_ACTIVITY","DAILY_ACCOUNT_FUNDING","MONTHLY_ACCOUNT_FUNDING","DAILY_AUTH_WINDOW"]}},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"Size of page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":20,"maximum":500}}],"responses":{"200":{"description":"Retrieved report type notification configuration for partner","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.ReportTypeNotificationPageResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Partner can not access this data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.ReportTypeNotificationPageResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Cards"],"summary":"Update report type notification configuration for partner","operationId":"updateNotificationConfigurationsForAGivenPartnerAndReportType","parameters":[{"name":"partnerId","in":"path","description":"Id of partner to set up notification for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"reportType","in":"path","description":"Type of report partner wants notification sent for","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["DAILY_CARD_ACTIVITY","MONTHLY_CARD_ACTIVITY","DAILY_ACCOUNT_FUNDING","MONTHLY_ACCOUNT_FUNDING","DAILY_AUTH_WINDOW"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.NotificationRequest"}}},"required":true},"responses":{"201":{"description":"Updated report type notification configuration for partner"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Partner can not update this data"}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"delete":{"tags":["Cards"],"summary":"Delete card report notification configuration for partner and report type","operationId":"deleteAllNotificationConfigurationsForAGivenPartnerAndReportType","parameters":[{"name":"partnerId","in":"path","description":"Id of partner to remove notification for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"reportType","in":"path","description":"Type of report partner is unsubscribing notification for","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["DAILY_CARD_ACTIVITY","MONTHLY_CARD_ACTIVITY","DAILY_ACCOUNT_FUNDING","MONTHLY_ACCOUNT_FUNDING","DAILY_AUTH_WINDOW"]}}],"responses":{"204":{"description":"Deleted report type notification configuration for partner"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Partner can not update this data"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/partners/{partnerId}/card-report-types/{reportType}/notifications/status":{"post":{"tags":["Cards"],"summary":"Toggle card report notification for partner and report type","operationId":"toggleNotificationsForAGivenPartnerAndReportType","parameters":[{"name":"partnerId","in":"path","description":"Id of partner to toggle notification for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"reportType","in":"path","description":"Type of report partner wants notification toggled for","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["DAILY_CARD_ACTIVITY","MONTHLY_CARD_ACTIVITY","DAILY_ACCOUNT_FUNDING","MONTHLY_ACCOUNT_FUNDING","DAILY_AUTH_WINDOW"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.UpdateCardReportNotificationRequest"}}},"required":true},"responses":{"204":{"description":"Toggled notifications for partner and report type"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Partner can not edit this data"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/partner/{partnerId}/bulk-card-custom-fields":{"post":{"tags":["Cards"],"summary":"Bulk create partner custom field keys","description":"Bulk create partner custom field keys","operationId":"bulkCreatePartnerCustomFieldKeys","parameters":[{"name":"partnerId","in":"path","description":"Id of partner to create custom fields for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.BulkCreateCustomFieldKeysRequest"}}},"required":true},"responses":{"201":{"description":"Custom field keys created successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/card-report-types/{reportType}/notifications":{"get":{"tags":["Cards"],"summary":"Retrieve card report type notification configuration for customer","operationId":"getNotificationConfigurationsForAGivenCustomerAndReportType","parameters":[{"name":"customerId","in":"path","description":"Id of customer to retrieve report type notification configuration for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"reportType","in":"path","description":"Type of report customer wants to retrieve notification configuration for","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["DAILY_CARD_ACTIVITY","MONTHLY_CARD_ACTIVITY","DAILY_ACCOUNT_FUNDING","MONTHLY_ACCOUNT_FUNDING","DAILY_AUTH_WINDOW"]}},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"Size of page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":20,"maximum":500}}],"responses":{"200":{"description":"Retrieved report type notification configuration for customer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.ReportTypeNotificationPageResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Customer can not access this data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.ReportTypeNotificationPageResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Cards"],"summary":"Update report type notification configuration for customer","operationId":"updateNotificationConfigurationsForAGivenCustomerAndReportType","parameters":[{"name":"customerId","in":"path","description":"Id of customer to set up notification for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"reportType","in":"path","description":"Type of report customer wants notification sent for","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["DAILY_CARD_ACTIVITY","MONTHLY_CARD_ACTIVITY","DAILY_ACCOUNT_FUNDING","MONTHLY_ACCOUNT_FUNDING","DAILY_AUTH_WINDOW"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.NotificationRequest"}}},"required":true},"responses":{"201":{"description":"Created report type notification configuration for customer"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Customer can not create this data"}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"delete":{"tags":["Cards"],"summary":"Delete card report notification configuration for customer and report type","operationId":"deleteAllNotificationConfigurationsForAGivenCustomerAndReportType","parameters":[{"name":"customerId","in":"path","description":"Id of customer to remove notification for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"reportType","in":"path","description":"Type of report customer is unsubscribing notification for","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["DAILY_CARD_ACTIVITY","MONTHLY_CARD_ACTIVITY","DAILY_ACCOUNT_FUNDING","MONTHLY_ACCOUNT_FUNDING","DAILY_AUTH_WINDOW"]}}],"responses":{"204":{"description":"Deleted report type notification configuration for customer"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Customer can not update this data"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/card-report-types/{reportType}/notifications/status":{"post":{"tags":["Cards"],"summary":"Toggled notifications for customer and card report type","operationId":"toggleNotificationsForAGivenCustomerAndReportType","parameters":[{"name":"customerId","in":"path","description":"Id of customer to toggle notification for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"reportType","in":"path","description":"Type of report customer wants notification toggled for","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["DAILY_CARD_ACTIVITY","MONTHLY_CARD_ACTIVITY","DAILY_ACCOUNT_FUNDING","MONTHLY_ACCOUNT_FUNDING","DAILY_AUTH_WINDOW"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.UpdateCardReportNotificationRequest"}}},"required":true},"responses":{"204":{"description":"Toggled notifications for customer and report type"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Customer can not edit this data"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customer/{customerId}/bulk-card-custom-fields":{"post":{"tags":["Cards"],"summary":"Bulk create customer custom field keys","description":"Bulk create customer custom field keys","operationId":"bulkCreateCustomerCustomFieldKeys","parameters":[{"name":"customerId","in":"path","description":"Id of customer to create custom fields for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.BulkCreateCustomFieldKeysRequest"}}},"required":true},"responses":{"201":{"description":"Custom field keys created successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}":{"get":{"tags":["Cards"],"summary":"View the details of an existing card","operationId":"getCard","parameters":[{"name":"cardId","in":"path","description":"The ID of the card to view","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Card returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.CardResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Cards"],"summary":"Update a card","description":"Update card and cardholder details","operationId":"update","parameters":[{"name":"cardId","in":"path","description":"The ID of the card to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.UpdateCardRequest"}}},"required":true},"responses":{"204":{"description":"Card updated successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"patch":{"tags":["Cards"],"summary":"Update card","description":"Update card - for now, the removal of cancellationDate, authWindowStartDate and authWindowEndDate fields and the update of frequencyUsage field are the only allowed actions","operationId":"updateCard","parameters":[{"name":"cardId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/card.Add"},{"$ref":"#/components/schemas/card.Copy"},{"$ref":"#/components/schemas/card.Move"},{"$ref":"#/components/schemas/card.Remove"},{"$ref":"#/components/schemas/card.Replace"},{"$ref":"#/components/schemas/card.Test"}]}}}},"required":true},"responses":{"204":{"description":"Card updated successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Forbidden. Token may be missing or invalid"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/unsuspend":{"post":{"tags":["Restricted","Cards"],"summary":"[Restricted] Unsuspend a card","description":"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.","operationId":"unsuspendCard","parameters":[{"name":"cardId","in":"path","description":"The ID of the card which should no longer be suspended","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Card unsuspended successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/unblock":{"post":{"tags":["Cards"],"summary":"Unblock an existing card","description":"Unblocking a card re-enables normal authorisation processing.","operationId":"unblockCard","parameters":[{"name":"cardId","in":"path","description":"The ID of the card which should be unblocked","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Card unblocked successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/suspend":{"post":{"tags":["Restricted","Cards"],"summary":"[Restricted] Suspend an existing card","description":"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.","operationId":"suspendCard","parameters":[{"name":"cardId","in":"path","description":"The ID of the card which should be suspended","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Card suspended successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/share-secure-details":{"get":{"tags":["Share secure card details"],"summary":"Retrieve share secure card details","description":"This endpoint allows the user to retrieve the share secure card details for a specific card","operationId":"getShareSecureCardDetails","parameters":[{"name":"cardId","in":"path","description":"The ID of the card to retrieve share secure card details for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"excludeTerminated","in":"query","description":"Exclude terminated share secure card details","required":false,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","minimum":0}},{"name":"size","in":"query","description":"Size of page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","maximum":500}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.ShareSecureCardDetailsPageResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Invalid permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.ShareSecureCardDetailsPageResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Share secure card details"],"summary":"Share secure card details via EMAIL or RETURN methods","description":"This endpoint allows the user to create a link to share secure card details for a specific card","operationId":"createShareSecureDetails","parameters":[{"name":"cardId","in":"path","description":"The ID of the card to share secure card details for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.ShareSecureCardDetailsRequest"}}},"required":true},"responses":{"201":{"description":"Share secure card details link successfully created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/card.CreateShareSecureCardDetailsResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Invalid permissions","content":{"*/*":{"schema":{"$ref":"#/components/schemas/card.CreateShareSecureCardDetailsResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"delete":{"tags":["Share secure card details"],"summary":"Delete all share secure card details for a card","description":"This endpoint allows the user to delete the link to share secure card details for a specific card","operationId":"deleteShareSecureDetailsCardLink","parameters":[{"name":"cardId","in":"path","description":"The ID of the card to delete share secure card details for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Share secure card details link successfully deleted"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Invalid permissions"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/secure-details-token":{"post":{"tags":["Cards"],"summary":"Create secure card details token","description":"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.","operationId":"generateCardHolderToken","parameters":[{"name":"X-MOD-CARD-MGMT-TOKEN","in":"header","description":"Card Management Token required when the token will be used to alter card details","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"cardId","in":"path","description":"The ID of the card to generate the token","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.OneTimeTokenRequest"}}}},"responses":{"200":{"description":"Card token generated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.OneTimeTokenResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/replace":{"post":{"tags":["Cards"],"summary":"Replace a card","description":"Replace a card, with a reason STOLEN, DAMAGED, LOST, RENEW.","operationId":"replaceCard","parameters":[{"name":"cardId","in":"path","description":"The ID of the card","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.CardReplacementRequest"}}},"required":true},"responses":{"201":{"description":"Card replaced successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.CardReplacementResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/pin":{"get":{"tags":["Cards"],"summary":"Retrieve PIN","description":"Retrieves the PIN for a card, as a reminder for the cardholder","operationId":"retrievePIN","parameters":[{"name":"X-MOD-CARD-MGMT-TOKEN","in":"header","description":"Card Management Token required for API users for additional security when managing sensitive card data","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"cardId","in":"path","description":"The ID of the card to retrieve the PIN for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"PIN retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.CardPinResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Forbidden. `Card Management Token` may be missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.CardPinResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Cards"],"summary":"Reset card PIN","description":"Reset the card's PIN for a specific card","operationId":"resetPin","parameters":[{"name":"X-MOD-CARD-MGMT-TOKEN","in":"header","description":"Card Management Token required for API users for additional security when managing sensitive card data","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"cardId","in":"path","description":"The ID of the card to reset the PIN for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.ResetCardPinRequest"}}},"required":true},"responses":{"204":{"description":"PIN changed successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Forbidden. `Card Management Token` may be missing or invalid"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/pin/unblock":{"post":{"tags":["Cards"],"summary":"Unblock PIN","description":"Unblock the card's PIN so that it can be used by the cardholder. CVC2 will also be unblocked, where required.","operationId":"unblockPin","parameters":[{"name":"cardId","in":"path","description":"The ID of the card to unblock the PIN (and/or CVC2) against","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Unblocked successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/in-app-provisioning/apple":{"post":{"tags":["Cards"],"summary":"Get in-app provisioning data for Apple Pay","description":"Retrieves and encrypts the data needed for the client application to provision a card to Apple Pay","operationId":"getInAppProvisioningForApple","parameters":[{"name":"cardId","in":"path","description":"Card ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"V110000001"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.AppleInAppProvisioningRequest"}}},"required":true},"responses":{"200":{"description":"In app provisioning data for Apple Pay retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.AppleInAppProvisioningResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/custom-fields":{"post":{"tags":["Cards"],"summary":"Update a card's custom fields","description":"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","operationId":"updateCardCustomFields","parameters":[{"name":"cardId","in":"path","description":"Id of the card for which the custom fields should be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.UpdateCardCustomFieldsRequest"}}},"required":true},"responses":{"204":{"description":"Custom fields updated successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/cancel":{"post":{"tags":["Cards"],"summary":"Cancel an existing card","description":"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.","operationId":"cancelCard","parameters":[{"name":"cardId","in":"path","description":"The ID of the card which should be cancelled","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.CancelCardRequest"}}}},"responses":{"200":{"description":"Card cancelled successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/block":{"post":{"tags":["Cards"],"summary":"Block an existing card","description":"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.","operationId":"blockCard","parameters":[{"name":"cardId","in":"path","description":"The ID of the card which should be blocked","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Card blocked successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/activate":{"post":{"tags":["Cards"],"summary":"Activate a physical card","description":"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`.","operationId":"activateCard","parameters":[{"name":"X-MOD-CARD-MGMT-TOKEN","in":"header","description":"Card Management Token required for API users for additional security when managing sensitive card data","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"cardId","in":"path","description":"The ID of the physical card which should be activated.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Card activated successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Forbidden. `Card Management Token` may be missing or invalid"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/secure-pin-reset":{"post":{"tags":["Cards"],"summary":"Reset card PIN","description":"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","operationId":"secureResetPin","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.ResetCardPinRequest"}}},"required":true},"responses":{"204":{"description":"PIN changed successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Forbidden. Authentication details may not be valid"}},"security":[]}},"/cards/enquiry":{"post":{"tags":["Cards"],"summary":"Card enquiry","description":"Retrieve card details by PAN","operationId":"cardEnquiry","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.CardEnquiryRequest"}}},"required":true},"responses":{"200":{"description":"Card enquiry successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.CardResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/card-tokens/{tokenId}/unsuspend":{"post":{"tags":["Cards"],"summary":"Unsuspend card token","description":"Restores a previously suspended token to active","operationId":"unsuspendCardToken","parameters":[{"name":"tokenId","in":"path","description":"Card token ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"T110000001"}],"responses":{"204":{"description":"Card token was unsuspended successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"404":{"description":"Not found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/card-tokens/{tokenId}/suspend":{"post":{"tags":["Cards"],"summary":"Suspend card token","description":"Suspends a token to temporarily prevent any new authorisations","operationId":"suspendCardToken","parameters":[{"name":"tokenId","in":"path","description":"Card token ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"T110000001"}],"responses":{"204":{"description":"Card token was suspended successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"404":{"description":"Not found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/card-tokens/{tokenId}/deactivate":{"post":{"tags":["Cards"],"summary":"Deactivate card token","description":"Deactivating a token permanently disables authorisation processing. This action is irreversible","operationId":"deactivateCardToken","parameters":[{"name":"tokenId","in":"path","description":"Card token ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"T110000001"}],"responses":{"204":{"description":"Card token was deactivated successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"404":{"description":"Not found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/bulk-cards":{"get":{"tags":["Cards Bulk Operations"],"summary":"List active bulk card requests","description":"Retrieve non-terminated (not processed/archived/deleted) bulk card requests for current user","operationId":"getActiveBulkCardRequests","parameters":[{"name":"page","in":"query","description":"Page to retrieve (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"Page to retrieve (0 indexed)","example":0,"minimum":0},"example":0},{"name":"size","in":"query","description":"Page size","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"Page size","example":500,"maximum":500,"minimum":1},"example":500}],"responses":{"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Forbidden. Incorrect permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.BulkRequestPageResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Cards Bulk Operations"],"summary":"Submit bulk cards operations","description":"Send Card details for Create/Update/Cancel/Patch Cards in bulk. Processing part will be asynchronous","operationId":"submitBulkCardOperations","parameters":[{"name":"validateOnly","in":"query","description":"Flag of whether to validate batch entries and not submit for processing. Default false.","required":true,"style":"form","explode":true,"schema":{"type":"boolean"}},{"name":"keepOperations","in":"query","description":"Flag of whether to persist operations for batch request. Can only be true if validateOnly is true, default is false.","required":true,"style":"form","explode":true,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.BulkCardsOpsRequest"}}},"required":true},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.BulkCardsOpsResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Forbidden. Incorrect permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.BulkCardsOpsResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/bulk-cards/upload":{"post":{"tags":["Cards Bulk Operations"],"summary":"Upload CSV file with bulk card operations","description":"Allow clients to upload csv file with create, update and change card status requests","operationId":"uploadBulkCards","parameters":[{"name":"validateOnly","in":"query","description":"Flag of whether to validate batch entries and not submit for processing. Default false.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}},{"name":"keepEntries","in":"query","description":"Flag of whether to persist entries for batch request. Can only be true if validateOnly is true, default is false","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}},{"name":"overrideFile","in":"query","description":"Flag of whether to replace existing file with same name. Default false.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"CSV file containing bulk card operations"}},"required":["file"]}}}},"responses":{"202":{"description":"CSV file accepted and validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.BulkCardsOpsResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Forbidden. Incorrect permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.BulkCardsOpsResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/authorisations/{authId}/expire":{"post":{"tags":["Restricted","Cards"],"summary":"[Restricted] Expire an existing authorisation","description":"[Restricted] Expire an existing authorisation. Note: CREDIT_AUTH and CREDIT_AUTH_REV activities cannot be expired via this endpoint.","operationId":"expireAuthorisation","parameters":[{"name":"authId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Authorisation expired successfully"},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"404":{"description":"Authorisation not found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/accounts/{accountId}/physical-cards":{"post":{"tags":["Cards"],"summary":"Create a new physical card","description":"Asynchronously create a physical card. The response will include a resource to allow the client to check the status of the request.","operationId":"createPhysicalCard","parameters":[{"name":"accountId","in":"path","description":"The account which card funds will be raised from.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.CreatePhysicalCardRequest"}}},"required":true},"responses":{"202":{"description":"Create physical card request received successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.AsyncTaskCreatedResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/accounts/{accountId}/cards":{"get":{"tags":["Cards"],"summary":"View the details of existing cards by account","operationId":"getCardsByAccount","parameters":[{"name":"accountId","in":"path","description":"Account ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"statuses","in":"query","description":"Statuses of cards to be retrieved","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["CREATED","ACTIVE","BLOCKED","SUSPENDED","CANCELLED","EXPIRED"]}},{"name":"page","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Cards returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.CardPageResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Cards"],"summary":"Create a new virtual card","operationId":"createCard","parameters":[{"name":"accountId","in":"path","description":"The account which card funds will be raised from.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.CreateCardRequest"}}},"required":true},"responses":{"201":{"description":"Virtual card created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.CreateCardResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/partner/{partnerId}/card-custom-fields":{"get":{"tags":["Cards"],"summary":"View existing partner card custom field keys","operationId":"getPartnerCustomFieldKeys","parameters":[{"name":"partnerId","in":"path","description":"Id of partner to retrieve custom fields for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"statuses","in":"query","description":"Statuses of the card custom field keys to be retrieved. If omitted default statuses 'ASSIGNED' and 'AVAILABLE' will be applied.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["ASSIGNED","ASSIGNED_DELETED","AVAILABLE","UNAVAILABLE"]}},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"Size of page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":20,"maximum":500}}],"responses":{"200":{"description":"Card custom fields for partner returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.CardCustomFieldKeyPageResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customer/{customerId}/card-custom-fields":{"get":{"tags":["Cards"],"summary":"View existing customer card custom field keys","operationId":"getCustomerCustomFieldKeys","parameters":[{"name":"customerId","in":"path","description":"Id of customer to retrieve custom fields for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"statuses","in":"query","description":"Statuses of the card custom field keys to be retrieved. If omitted default statuses 'ASSIGNED' and 'AVAILABLE' will be applied.","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["ASSIGNED","ASSIGNED_DELETED","AVAILABLE","UNAVAILABLE"]}},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"Size of page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":20,"maximum":500}}],"responses":{"200":{"description":"Card custom fields for customer returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.CardCustomFieldKeyPageResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards":{"get":{"tags":["Cards"],"summary":"View the details of existing cards","operationId":"getCards","parameters":[{"name":"fromCreatedDate","in":"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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"2019-03-01T01:01:01+0000"},{"name":"toCreatedDate","in":"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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"2019-03-01T01:01:01+0000"},{"name":"statuses","in":"query","description":"Statuses of cards to be retrieved","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["CREATED","ACTIVE","BLOCKED","SUSPENDED","CANCELLED","EXPIRED"]}},{"name":"id","in":"query","description":"The ID of the card to view.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"V000000001"},{"name":"accountId","in":"query","description":"The ID of account to retrieve cards for.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"A0000001"},{"name":"externalRef","in":"query","description":"The client reference of the card to retrieve.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"ExampleCardRef123"},{"name":"customerId","in":"query","description":"The ID of the customer to retrieve cards for.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"C0000001"},{"name":"currency","in":"query","description":"Currency to get cards for. Expected ISO Standard currency name i.e. GBP, EUR etc","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"GBP"},{"name":"customFieldKey","in":"query","description":"Custom Field Key to get cards for","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"BookingReference"},{"name":"customFieldValue","in":"query","description":"Custom Field Value corresponding to the custom field key to get cards for","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"Booking123"},{"name":"accountIds","in":"query","description":"Set of account Ids to retrieve cards for.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true},"example":"A0000001"},{"name":"channelManagerId","in":"query","description":"The Id of the Channel manager","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"M883412312"},{"name":"frequencyUsage","in":"query","description":"How many times a card can be authorised against. This parameter is rejected for physical cards","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["SINGLE_USE","MULTI_USE"]}},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","minimum":0}},{"name":"size","in":"query","description":"Size of page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","maximum":500}}],"responses":{"200":{"description":"Cards returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.CardPageResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/tokens":{"get":{"tags":["Cards"],"summary":"Get card tokens","description":"Retrieves all payment card tokens for the given card","operationId":"getCardTokens","parameters":[{"name":"cardId","in":"path","description":"Card ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"V110000001"},{"name":"includeDeletedDevices","in":"query","description":"Include deleted devices in results","required":false,"style":"form","explode":true,"schema":{"type":"boolean"},"example":true}],"responses":{"200":{"description":"Card tokens retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.GetCardTokensResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/share-secure-details/{shareSecureDetailsId}/activity":{"get":{"tags":["Share secure card details"],"summary":"Retrieve share details activity of token","description":"This endpoint allows the user to retrieve the share secure card details activity for a specific share token","operationId":"getShareSecureCardDetailsTokenActivity","parameters":[{"name":"cardId","in":"path","description":"The ID of the card to retrieve share secure card details activity for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"shareSecureDetailsId","in":"path","description":"The ID of the share secure card details to retrieve activity for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.ShareSecureCardDetailsTokenActivityPageResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Invalid permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.ShareSecureCardDetailsTokenActivityPageResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/secure-details":{"get":{"tags":["Cards"],"summary":"Retrieve secure card details (PAN + CVV + PIN)","description":"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","operationId":"getSecureCardDetails","responses":{"200":{"description":"Secure card details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.SecureCardDetails"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Forbidden. Token may be missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.SecureCardDetails"}}}}},"security":[]}},"/card-tokens/{tokenId}/otp":{"get":{"tags":["Cards"],"summary":"Get card token OTP details","description":"Retrieves the OTP details given the corresponding card token ID","operationId":"getOtpDetails","parameters":[{"name":"tokenId","in":"path","description":"Card token ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"T110000001"}],"responses":{"200":{"description":"OTP details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.OtpDetails"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.OtpDetails"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/card-tasks":{"get":{"tags":["Async","Cards"],"summary":"Get tasks","description":"View the details of card tasks.  Ordered by createdDate, with the newest entries appearing first","operationId":"getAsyncTasks","parameters":[{"name":"id","in":"query","description":"The ID of the card task","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"T000000001"},{"name":"aid","in":"query","description":"The account ID to retrieve card tasks for","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"A0000001"},{"name":"statuses","in":"query","description":"Statuses of card tasks to be retrieved","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["RECEIVED","RUNNING","COMPLETE","ERROR"]}},{"name":"types","in":"query","description":"Types of card tasks to be retrieved","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["PHYSICAL_CARD_CREATE"]}},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"Size of page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":20,"maximum":500}}],"responses":{"200":{"description":"Tasks returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.AsyncTaskPageResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/card-tasks/{taskId}":{"get":{"tags":["Async"],"summary":"Get a card task","description":"Retrieve the card task. If the task is complete, the resource URL will be provided to allow client to fetch the completed resource.","operationId":"getAsyncTask","parameters":[{"name":"taskId","in":"path","description":"The ID of the card task","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details returned of the card task. If task is complete, response will include link to resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.AsyncTaskResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/card-reports":{"get":{"tags":["Cards"],"summary":"Retrieve card reports","description":"Retrieve card reports","operationId":"searchReports","parameters":[{"name":"fromReportDate","in":"query","description":"Retrieve reports equal to or after this date","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Retrieve reports equal to or after this date","example":"2023-01-01"},"example":"2023-01-01"},{"name":"toReportDate","in":"query","description":"Retrieve reports equal to or before this date","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Retrieve reports equal to or before this date","example":"2023-01-30"},"example":"2023-01-30"},{"name":"reportTypes","in":"query","description":"Report types","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/card.reportTypes"},"example":"DAILY_CARD_ACTIVITY"},{"name":"reportSubjectIds","in":"query","description":"Report subject Ids (Customer BID, Partner BID or Channel Manager BID)","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/card.reportSubjectIds"},"example":"C1000001"},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0,"description":"Page to fetch (0 indexed)","minimum":0}},{"name":"size","in":"query","description":"The size of the page(s)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"The size of the page(s)","maximum":500,"minimum":1}},{"name":"sortField","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","pattern":"(reportDate|reportType)"}},{"name":"sortOrder","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","pattern":"(asc|desc)"}}],"responses":{"200":{"description":"Card reports retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.ReportPageResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Unauthorised","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.ReportPageResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/card-reports/{reportId}/report":{"get":{"tags":["Cards"],"summary":"Download a specific card report","description":"Download a specific card report","operationId":"retrieveReport","parameters":[{"name":"reportId","in":"path","description":"ID of the report to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Card report retrieved successfully","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Unauthorised","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not found","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/card-reports/{reportId}/download":{"get":{"tags":["Cards"],"summary":"Download a specific card report","description":"Download a specific card report","operationId":"retrievePreSignedReportUrl","parameters":[{"name":"reportId","in":"path","description":"ID of the report to download","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Card report retrieved successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/card.DownloadReportResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Unauthorised","content":{"*/*":{"schema":{"$ref":"#/components/schemas/card.DownloadReportResponse"}}}},"404":{"description":"Not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/card.DownloadReportResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/bulk-cards/{bulkRequestId}":{"get":{"tags":["Cards Bulk Operations"],"summary":"Get bulk cards by id","description":"Get all batch specific information","operationId":"getBulkCardsInfo","parameters":[{"name":"bulkRequestId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.BulkCardsInfoResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Forbidden. Incorrect permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.BulkCardsInfoResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"delete":{"tags":["Cards Bulk Operations"],"summary":"Mark bulk request as deleted","description":"Allows client to mark bulk request as deleted if not already processed, processed with errors or archived","operationId":"deleteBulkRequest","parameters":[{"name":"bulkRequestId","in":"path","description":"Business id of bulk request to mark as deleted","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Bulk request successfully marked as deleted"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Forbidden. Incorrect permissions"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/activities":{"get":{"tags":["Cards"],"summary":"View activities for specific cards or over a date range","description":"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.","operationId":"getCardActivities","parameters":[{"name":"fromCreatedDate","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"2019-01-01T15:14:38-0000"},{"name":"toCreatedDate","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"2019-01-01T15:14:38-0000"},{"name":"statuses","in":"query","description":"Activities with possibly multiple statuses equal to this value. Omitting this is equivalent to supplying all values","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["DECLINED","APPROVED","SETTLED","EXPIRED","APPLIED","PENDING"]}},{"name":"types","in":"query","description":"Activities with possibly multiple types equal to this value. Omitting this is equivalent to supplying all values","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["AUTHORISATION","REVERSAL","SETTLEMENT","REFUND","ORIGINAL_CREDIT","OFFLINE_TRANSACTION","ASI","CREDIT_AUTH","CREDIT_AUTH_REV"]}},{"name":"cards","in":"query","description":"Activities with possibly multiple card IDs equal to this value. Only one of 'cards' or 'accounts' must be supplied","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"accounts","in":"query","description":"Activities with possibly multiple account IDs equal to this value. Only one of 'cards' or 'accounts' must be supplied","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"ids","in":"query","description":"Activities with the specified IDs. Only 'page' and/or 'size' may be used in conjunction with this filter.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"orderId","in":"query","description":"Activites with specified Order Id","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"channelManagerId","in":"query","description":"Id of channel manager to return activities for","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"sortFields","in":"query","description":"A list of fields to sort the response by. Sorting will be applied in the order the fields are given","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["createdDate","orderId"]}},{"name":"sortOrders","in":"query","description":"A list of orders to apply to the respective sortFields. The only accepted sortOrders will be ASC and DESC (case insensitive)","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["ASC","DESC"]}},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","minimum":0}},{"name":"size","in":"query","description":"Size of page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","maximum":500}}],"responses":{"200":{"description":"Card activity data returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.CardActivityPageResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/accounts/{accountId}/physical-card-request-tasks":{"get":{"tags":["Async","Cards"],"summary":"Get physical card create tasks by account","description":"View the details of create physical card tasks by account.  Ordered by createdDate, with the newest entries appearing first","operationId":"getCreatePhysicalCardAsyncTasksByAccount","parameters":[{"name":"accountId","in":"path","description":"The account ID to retrieve create physical card tasks for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"statuses","in":"query","description":"Statuses of tasks to be retrieved","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["RECEIVED","RUNNING","COMPLETE","ERROR"]}},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"Size of page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":20,"maximum":500}}],"responses":{"200":{"description":"Tasks returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/card.AsyncTaskPageResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/share-secure-details/{shareId}":{"delete":{"tags":["Share secure card details"],"summary":"Delete share secure card details","description":"This endpoint allows the user to delete the share secure card details for a specific Id","operationId":"deleteShareSecureDetails","parameters":[{"name":"shareId","in":"path","description":"The id of the share secure card details to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Share secure card details deleted successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}},"403":{"description":"Invalid permissions"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/partner/{partnerId}/card-custom-fields/{key}":{"delete":{"tags":["Cards"],"summary":"Delete partner custom field key","description":"Delete partner custom field key","operationId":"deletePartnerCustomFieldKey","parameters":[{"name":"partnerId","in":"path","description":"Id of partner to delete custom field for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"key","in":"path","description":"Key of the field to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"202":{"description":"Custom field key successfully deleted"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customer/{customerId}/card-custom-fields/{key}":{"delete":{"tags":["Cards"],"summary":"Delete customer custom field key","description":"Delete customer custom field key","operationId":"deleteCustomerCustomFieldKey","parameters":[{"name":"customerId","in":"path","description":"Id of customer to delete custom field for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"key","in":"path","description":"Key of the field to delete","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"202":{"description":"Custom field key successfully deleted"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/cards/{cardId}/custom-fields/{key}":{"delete":{"tags":["Cards"],"summary":"Delete card custom field","description":"Delete card custom field","operationId":"deleteCardCustomField","parameters":[{"name":"cardId","in":"path","description":"Id of card the custom field should be deleted for","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"key","in":"path","description":"Key of the key value pair of custom field that should be removed for the card","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Custom field key successfully deleted"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/card.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/directdebits/reject":{"post":{"tags":["Direct Debit Outbound Mandate Operations"],"summary":"Reject Collection","description":"Reject Collection","operationId":"rejectCollection","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/directdebitoutbound.CollectionRejectRequest"}}},"required":true},"responses":{"200":{"description":"Collection has been rejected"},"400":{"description":"Collection has not been rejected","content":{"application/json":{"schema":{"$ref":"#/components/schemas/directdebitoutbound.MessageResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/directdebits/cancel":{"post":{"tags":["Direct Debit Outbound Mandate Operations"],"summary":"Cancel a specific Mandate","description":"Used to request the cancellation of a Mandate.","operationId":"cancelDdosMandate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/directdebitoutbound.MandateCancelRequest"}}},"required":true},"responses":{"200":{"description":"Mandate was successfully cancelled"},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebitoutbound.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/directdebits/enquire/{accountId}":{"get":{"tags":["Direct Debit Outbound Mandate Operations"],"summary":"Retrieve all Mandates for an account","description":"Used to get all the Mandates for a specific account.","operationId":"retrieveMandates","parameters":[{"name":"accountId","in":"path","description":"Account Id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"All Mandates were successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/directdebitoutbound.EnquiryMandatesResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/directdebitoutbound.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/payment-files":{"post":{"tags":["File Upload"],"summary":"Upload payment file and store valid payments","description":"Uploads the payment file and store the valid files extracted payments for later creating payments","operationId":"upload-payment-file","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paymentfileupload.FileUploadRequest"}}},"required":true},"responses":{"200":{"description":"File upload response with the file bid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/paymentfileupload.FileUploadResponse"}}}},"400":{"description":"Invalid upload content or file size exceeded","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/paymentfileupload.MessageResponse"}}}}},"500":{"description":"500 error code is issued when problem occurred during decoding and decompressing file content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/paymentfileupload.FileUploadResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/payment-files/{fileId}/proceed":{"post":{"tags":["File Upload"],"summary":"Create payments from an uploaded file","description":"Create a batch payment request from a valid upload file and send for processing to the payment service","operationId":"proceed","parameters":[{"name":"fileId","in":"path","description":"Payment File ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paymentfileupload.FileCreateRequest"}}},"required":true},"responses":{"201":{"description":"File created response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/paymentfileupload.FileCreatePaymentsResponse"}}}},"400":{"description":"Invalid payment file","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/paymentfileupload.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/payment-files/proceed":{"post":{"tags":["File Upload"],"summary":"Create payments from one or more uploaded files","description":"Create batch payment requests from valid upload files with a single applicable MFA challenge and send for processing to the payment service","operationId":"proceed_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paymentfileupload.FilesCreatePaymentsRequest"}}},"required":true},"responses":{"201":{"description":"File created response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/paymentfileupload.FilesCreatePaymentsResponse"}}}},"400":{"description":"Invalid payment file","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/paymentfileupload.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/payment-files/{fileId}":{"get":{"tags":["File Upload"],"summary":"Get an upload file latest status","description":"Get latest status of an uploaded payment file","operationId":"status","parameters":[{"name":"fileId","in":"path","description":"Payment File ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"File upload status response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/paymentfileupload.FileUploadStatusResponse"}}}},"400":{"description":"Invalid Payment file","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/paymentfileupload.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/payment-files/{fileId}/summaries":{"get":{"tags":["File Upload"],"summary":"Get paginated summaries of child file uploads","description":"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.","operationId":"summaries","parameters":[{"name":"fileId","in":"path","description":"Payment File ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0,"minimum":0}},{"name":"size","in":"query","description":"Page size (max 500)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":20,"exclusiveMinimum":0,"maximum":500}}],"responses":{"200":{"description":"Paginated file upload summaries response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/paymentfileupload.FileUploadSummariesResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/paymentfileupload.MessageResponse"}}}}},"404":{"description":"File not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/paymentfileupload.FileUploadSummariesResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/account-name-check":{"post":{"tags":["Confirmation of Payee"],"summary":"Create an account name check","description":"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>","operationId":"createOutboundCop","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/confirmationofpayee.JsonOutboundCopRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/confirmationofpayee.JsonOutboundCopResponse"}}}},"400":{"description":"Validation Errors","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/confirmationofpayee.JsonOutboundCopErrorResponse"}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/confirmationofpayee.JsonOutboundCopErrorResponse"}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/confirmationofpayee.JsonOutboundCopErrorResponse"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/confirmationofpayee.JsonOutboundCopErrorResponse"}}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/confirmationofpayee.JsonOutboundCopErrorResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/account-name-check/payer":{"post":{"tags":["Confirmation of Payee"],"summary":"Create an account name check for Direct Debit Payer","description":"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>","operationId":"createOutboundCheckForPnv","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/confirmationofpayee.JsonOutboundCopRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/confirmationofpayee.JsonOutboundCopResponse"}}}},"400":{"description":"Validation Errors","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/confirmationofpayee.JsonOutboundCopErrorResponse"}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/confirmationofpayee.JsonOutboundCopErrorResponse"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/confirmationofpayee.JsonOutboundCopErrorResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/account-name-check/srd-accounts":{"get":{"tags":["Confirmation of Payee"],"summary":"Get SRD Accounts","description":"Returns a list of all sort codes and account numbers for which Secondary Reference Data must be provided with all account name check requests.","operationId":"getSrdAccounts","parameters":[{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0,"minimum":0}},{"name":"size","in":"query","description":"Size of Page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":500,"maximum":500,"minimum":1}}],"responses":{"200":{"description":"Successfully retrieved SRD list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/confirmationofpayee.CopPageResponseJsonSrdAccount"}}}},"400":{"description":"Invalid query params provided","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/confirmationofpayee.MessageResponse"}}}}},"401":{"description":"Invalid credentials","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/confirmationofpayee.MessageResponse"}}}}},"403":{"description":"CoP Access denied","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/confirmationofpayee.MessageResponse"}}}}},"500":{"description":"Unexpected error occurred","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/confirmationofpayee.MessageResponse"}}}}},"503":{"description":"Service outage","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/confirmationofpayee.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/integration-notifications/{notificationId}":{"get":{"tags":["Integration Notification"],"summary":"Retrieve a specific Webhook Notification Subscription for a Customer using the Notification ID.","operationId":"getCustomerWebhookNotificationSubscription","parameters":[{"name":"customerId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"notificationId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integrationnotification.WebhookNotificationResponse"}}}},"400":{"description":"Bad request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/integrationnotification.MessageResponse"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integrationnotification.WebhookNotificationResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"put":{"tags":["Integration Notification"],"summary":"Update a specific Webhook Notification Subscription for a Customer.","operationId":"editCustomerWebhookNotificationSubscription","parameters":[{"name":"customerId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"notificationId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/integrationnotification.WebhookNotificationRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integrationnotification.WebhookNotificationResponse"}}}},"400":{"description":"Bad request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/integrationnotification.MessageResponse"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integrationnotification.WebhookNotificationResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"delete":{"tags":["Integration Notification"],"summary":"Delete a Webhook Notification Subscription for a Customer using the Notification ID.","operationId":"deleteCustomerWebhookNotificationSubscription","parameters":[{"name":"customerId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"notificationId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"NO CONTENT"},"400":{"description":"Bad request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/integrationnotification.MessageResponse"}}}}},"404":{"description":"Not found"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/integration-notifications":{"get":{"tags":["Integration Notification"],"summary":"Retrieve all Webhook Notification Subscriptions for a Customer.","operationId":"getAllCustomerWebhookNotificationSubscriptions","parameters":[{"name":"customerId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0,"minimum":0}},{"name":"size","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":20,"maximum":500,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integrationnotification.PaginatedWebhookNotificationResponse"}}}},"400":{"description":"Bad request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/integrationnotification.MessageResponse"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integrationnotification.PaginatedWebhookNotificationResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Integration Notification"],"summary":"Set up a new Webhook Notification Subscription for a Customer.","operationId":"addCustomerWebhookNotificationSubscription","parameters":[{"name":"customerId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/integrationnotification.WebhookNotificationRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integrationnotification.WebhookNotificationResponse"}}}},"400":{"description":"Bad request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/integrationnotification.MessageResponse"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integrationnotification.WebhookNotificationResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/integration-notification-webhooks/{notificationId}/failures":{"get":{"tags":["Integration Notification"],"summary":"Retrieve failed Webhook Notifications for a Webhook using the Notification ID.","operationId":"getFailedWebhookNotifications","parameters":[{"name":"notificationId","in":"path","description":"Id of notification","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"fromDateTime","in":"query","description":"Failed since Date. Needs to be urlEncoded value","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0,"minimum":0}},{"name":"size","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":20,"maximum":500,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integrationnotification.PaginatedWebhookFailureResponse"}}}},"400":{"description":"Bad request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/integrationnotification.MessageResponse"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integrationnotification.PaginatedWebhookFailureResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/vrp":{"post":{"tags":["Variable Recurring Payments"],"summary":"Initiate a Variable Recurring Payment.","description":"Initiates a new Variable Recurring Payment using an existing authorised consent.","operationId":"initiateVrpPayment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pispgateway.VrpPaymentRequest"}}},"required":true},"responses":{"201":{"description":"Variable Recurring Payment initiated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pispgateway.VrpPaymentResponse"}}}},"400":{"description":"The consent cannot be processed as it does not exist.","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pispgateway.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/vrp-consents":{"post":{"tags":["Variable Recurring Payments"],"summary":"Create a VRP consent","description":"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.","operationId":"initiateConsentCreation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pispgateway.CreateVrpConsentCreationRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pispgateway.CreateVrpConsentInitiationResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pispgateway.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/vrp-consents/{consentId}/funds-confirmation":{"post":{"tags":["Variable Recurring Payments"],"summary":"Confirm the availability of funds in an account.","description":"Confirm the availability of funds in account, prior to initiating a Variable Recurring Payment, using an authorised consent.","operationId":"confirmFunds","parameters":[{"name":"consentId","in":"path","description":"Vrp consent id","required":true,"style":"simple","explode":false,"schema":{"type":"string","minLength":1}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pispgateway.VrpConfirmationOfFundsRequest"}}},"required":true},"responses":{"200":{"description":"Confirmation of Funds successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pispgateway.VrpConfirmationOfFundsResponse"}}}},"400":{"description":"Confirmation of funds request cannot be processed as the consent with the provided ID does not exist.","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pispgateway.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/standing-order-initiations":{"post":{"tags":["Payment Initiations"],"summary":"Initiate standing order from ASPSP","description":"Initiate a new standing order to the specified destination account from an account held at an ASPSP.","operationId":"createStandingOrderInitiation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pispgateway.CreateStandingOrderInitiationRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pispgateway.CreateStandingOrderInitiationResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pispgateway.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/payment-initiations":{"post":{"tags":["Payment Initiations"],"summary":"Initiate payment from ASPSP","description":"Initiate a payment to the specified destination account from an account held at an ASPSP.","operationId":"createPaymentInitiation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pispgateway.CreatePaymentInitiationRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pispgateway.CreatePaymentInitiationResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pispgateway.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/vrp/{vrpPaymentId}":{"get":{"tags":["Variable Recurring Payments"],"summary":"Get Variable Recurring Payment","description":"Fetch the details of a payment initiated using Variable Recurring Payment (VRP) based on a unique payment ID.","operationId":"getVrpPayment","parameters":[{"name":"vrpPaymentId","in":"path","description":"Vrp Payment Id","required":true,"style":"simple","explode":false,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pispgateway.VrpPaymentDetailsResponse"}}}},"400":{"description":"The payment cannot be retrieved as it does not exist.","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pispgateway.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/vrp-consents/{consentId}":{"get":{"tags":["Variable Recurring Payments"],"summary":"Get VRP consent.","description":"Returns information about a given Variable Recurring Payment consent.","operationId":"getVrpConsent","parameters":[{"name":"consentId","in":"path","description":"Vrp consent id","required":true,"style":"simple","explode":false,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pispgateway.VrpConsentResponse"}}}},"400":{"description":"The consent details cannot be retrieved as it does not exist","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pispgateway.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"delete":{"tags":["Variable Recurring Payments"],"summary":"Revoke a VRP consent.","description":"Cancels a VRP consent and stops further variable recurring payments being made using it.","operationId":"revokeVrpConsent","parameters":[{"name":"consentId","in":"path","description":"Vrp consent id","required":true,"style":"simple","explode":false,"schema":{"type":"string","minLength":1}}],"responses":{"202":{"description":"Vrp consent revoked"},"400":{"description":"The consent cannot be revoked as it does not exist","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pispgateway.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/standing-order-initiations/{standingOrderInitiationId}":{"get":{"tags":["Payment Initiations"],"summary":"Get standing order initiation request details","description":"Retrieve the details of a specific standing order initiation request.","operationId":"getStandingOrderInitiation","parameters":[{"name":"standingOrderInitiationId","in":"path","description":"Standing order initiation ID","required":true,"style":"simple","explode":false,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Standing order initiation found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pispgateway.StandingOrderInitiationResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pispgateway.MessageResponse"}}}}},"404":{"description":"Standing order initiation not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pispgateway.StandingOrderInitiationResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/payment-initiations/{paymentInitiationId}":{"get":{"tags":["Payment Initiations"],"summary":"Get payment initiation request details","description":"Retrieve the details of a specific payment initiation request.","operationId":"getPaymentInitiation","parameters":[{"name":"paymentInitiationId","in":"path","description":"Payment initiation ID","required":true,"style":"simple","explode":false,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Payment initiation found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pispgateway.PaymentInitiationResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pispgateway.MessageResponse"}}}}},"404":{"description":"Payment initiation not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pispgateway.PaymentInitiationResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/aspsps":{"get":{"tags":["Payment Initiations"],"summary":"Get supported ASPSPs","description":"Gets a list of all supported Account Servicing Payment Service Providers (ASPSPs).","operationId":"getAspsProviders","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pispgateway.AspsProviderResponse"}}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pispgateway.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/keys/applications/{applicationId}":{"post":{"tags":["Customers"],"summary":"Create a secure Customer Verification SDK Session","description":"Creates a short-lived access key that authorises a Customer Verification session for the specified application.","operationId":"createSdkKey","parameters":[{"name":"applicationId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/onboarding.ApplicationSdkKeyResponse"}}}},"400":{"description":"Validation error","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/onboarding.MessageResponse"}}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/onboarding.ApplicationSdkKeyResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/applications":{"post":{"tags":["Customers"],"summary":"Create a New Onboarding Application","description":"Creates a new application with a unique identifier with a status of NEW.","operationId":"createApplication","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/onboarding.CreateApplicationRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/onboarding.CreateApplicationResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/onboarding.MessageResponse"}}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/onboarding.CreateApplicationResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/applications/{applicationId}/verify":{"post":{"tags":["Customers"],"summary":"Submit an application for verification","description":"Submits an application for initial KYB/KYC review once all required data is provided.","operationId":"verifyApplication","parameters":[{"name":"applicationId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/onboarding.MessageResponse"}}}}},"403":{"description":"Forbidden"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/applications/{applicationId}/submissions":{"post":{"tags":["Customers"],"summary":"Submit a business application for verification","description":"Initiates KYB verification for a business application and returns a submission reference.","operationId":"submitApplication","parameters":[{"name":"applicationId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/onboarding.SubmitApplicationResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/onboarding.MessageResponse"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/onboarding.SubmitApplicationResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/applications/{applicationId}/finalisations":{"post":{"tags":["Customers"],"summary":"Mark application as closed for modification","description":"Confirms all business and associate details have been submitted. The application will be processed for verification.","operationId":"finaliseApplication","parameters":[{"name":"applicationId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/onboarding.FinaliseApplicationResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/onboarding.MessageResponse"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/onboarding.FinaliseApplicationResponse"}}}},"404":{"description":"Application not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/onboarding.FinaliseApplicationResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/applications/{applicationId}/associates/{associateId}/submissions":{"post":{"tags":["Customers"],"summary":"Submit an associate for verification","description":"Submits an associate for KYB verification and returns a submission reference.","operationId":"submitAssociateForVerification","parameters":[{"name":"applicationId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"associateId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Submission successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/onboarding.SubmitAssociateResponse"}}}},"400":{"description":"Validation error - invalid application or associate","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/onboarding.MessageResponse"}}}}},"403":{"description":"Forbidden - insufficient permissions","content":{"*/*":{"schema":{"$ref":"#/components/schemas/onboarding.SubmitAssociateResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/documents":{"post":{"tags":["Document"],"summary":"Uploads and stores document","description":"Uploads and stores document in a repository. Gives back Url encoded document path in the repository","operationId":"upload","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/document.DocumentUploadRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/document.DocumentResponse"}}}},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/document.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/documents":{"post":{"tags":["Document"],"summary":"Uploads and stores documents associated with an existing customer record","description":"Upload and store documents related to an existing customer, typically those collected during Know Your Customer (KYC) or Know Your Business (KYB) verification processes","operationId":"upload_1","parameters":[{"name":"customerId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/document.CustomerDocumentUploadRequest"}}},"required":true},"responses":{"204":{"description":"NO_CONTENT"},"400":{"description":"Validation errors","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/document.MessageResponse"}}}}},"403":{"description":"Incorrect permissions"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/channel-managers/webhook-notifications":{"get":{"tags":["Channel Manager Webhook Notifications"],"summary":"Retrieve Webhook notification configurations","description":"Retrieve Webhook notification configurations for the authenticated Channel Manager","operationId":"channelManagerGetWebhookNotifications","parameters":[{"name":"page","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0,"minimum":0}},{"name":"size","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":20,"maximum":500,"minimum":1}}],"responses":{"200":{"description":"Webhook notifications retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.WebhookNotificationPageResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/channelmanager.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Channel Manager Webhook Notifications"],"summary":"Create a Webhook notification configuration","description":"Create a Webhook notification configuration for the authenticated Channel Manager","operationId":"channelManagerCreateWebhookNotification","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.CreateWebhookNotificationRequest"}}},"required":true},"responses":{"201":{"description":"Webhook notification created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.WebhookNotificationResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/channelmanager.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/channel-managers/cards/{cardId}":{"post":{"tags":["Channel Manager Card"],"summary":"Channel Manager Update card","description":"Update a virtual card","operationId":"channelManagerUpdateCard","parameters":[{"name":"cardId","in":"path","description":"The card id.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.UpdateCardRequest"}}},"required":true},"responses":{"204":{"description":"Virtual card updated successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/channelmanager.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"patch":{"tags":["Channel Manager Card"],"summary":"Channel Manager Update card","description":"Update card - for now, the removal of cancellationDate, authWindowStartDate and authWindowEndDate fields is the only allowed action","operationId":"channelManagerUpdateCard_1","parameters":[{"name":"cardId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/channelmanager.Add"},{"$ref":"#/components/schemas/channelmanager.Copy"},{"$ref":"#/components/schemas/channelmanager.Move"},{"$ref":"#/components/schemas/channelmanager.Remove"},{"$ref":"#/components/schemas/channelmanager.Replace"},{"$ref":"#/components/schemas/channelmanager.Test"}]}}}},"required":true},"responses":{"204":{"description":"Card updated successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/channelmanager.MessageResponse"}}}}},"403":{"description":"Forbidden. Token may be missing or invalid"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/channel-managers/cards/{cardId}/replace":{"post":{"tags":["Channel Manager Card"],"summary":"Channel Manager Replace card ","description":"Replace a card, with a reason STOLEN, DAMAGED, LOST, RENEW","operationId":"channelManagerReplaceCard","parameters":[{"name":"cardId","in":"path","description":"The ID of the card","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.CardReplacementRequest"}}},"required":true},"responses":{"201":{"description":"Card replaced successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.CardReplacementResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/channelmanager.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/channel-managers/cards/{cardId}/custom-fields":{"post":{"tags":["Channel Manager Card"],"summary":"Channel Manager Update Card Custom Fields","description":"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","operationId":"channelManagerUpdateCardCustomFields","parameters":[{"name":"cardId","in":"path","description":"Id of the card for which the custom fields should be updated","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.UpdateCardCustomFieldsRequest"}}},"required":true},"responses":{"204":{"description":"Custom fields updated successfully"},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/channelmanager.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/channel-managers/cards/enquiry":{"post":{"tags":["Channel Manager Card"],"summary":"Channel Manager Card enquiry","description":"Retrieve card details by PAN","operationId":"channelManagerCardEnquiry","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.CardEnquiryRequest"}}},"required":true},"responses":{"200":{"description":"Card enquiry successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.CardResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/channelmanager.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/channel-managers/accounts/{accountId}/cards":{"post":{"tags":["Channel Manager Card"],"summary":"Channel Manager Create card ","description":"Create a new virtual card","operationId":"channelManagerCreateCard","parameters":[{"name":"accountId","in":"path","description":"The account which card funds will be raised from.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.CreateCardRequest"}}},"required":true},"responses":{"201":{"description":"Virtual card created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.CreateCardResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/channelmanager.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/channel-managers/webhook-notifications/{notificationId}":{"get":{"tags":["Channel Manager Webhook Notifications"],"summary":"Retrieve Webhook notification configuration","description":"Retrieve a Webhook notification configuration for the authenticated Channel Manager","operationId":"channelManagerGetWebhookNotification","parameters":[{"name":"notificationId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Webhook notification retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.WebhookNotificationResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/channelmanager.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"patch":{"tags":["Channel Manager Webhook Notifications"],"summary":"Update a specific Webhook notification configuration for a Channel Manager","description":"Update a specific Webhook notification configuration for a Channel Manager. Replace operations are the only available","operationId":"channelManagerUpdateWebhookNotification","parameters":[{"name":"notificationId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/channelmanager.Replace"}}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"When parameters are invalid parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/channelmanager.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/channel-managers/webhook-notifications/{notificationId}/failures":{"get":{"tags":["Channel Manager Webhook Notifications"],"summary":"Retrieve Webhook notification configurations","description":"Retrieve Webhook notification configurations for the authenticated Channel Manager","operationId":"channelManagerGetWebhookNotifications_1","parameters":[{"name":"notificationId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0,"minimum":0}},{"name":"size","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":20,"maximum":500,"minimum":1}}],"responses":{"200":{"description":"Webhook notifications retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.WebhookNotificationPageResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/channelmanager.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/channel-managers/cards":{"get":{"tags":["Channel Manager Card"],"summary":"Retrieve channel manager's cards","description":"Retrieve cards owned by the channel manager","operationId":"channelManagerGetCards","parameters":[{"name":"fromCreatedDate","in":"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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"2019-03-01T01:01:01+0000"},{"name":"toCreatedDate","in":"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.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"2019-03-01T01:01:01+0000"},{"name":"statuses","in":"query","description":"Statuses of cards to be retrieved","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["CREATED","ACTIVE","BLOCKED","SUSPENDED","CANCELLED","EXPIRED"]}},{"name":"id","in":"query","description":"The ID of the card to view.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"V000000001"},{"name":"accountId","in":"query","description":"The ID of account to retrieve cards for.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"A0000001"},{"name":"externalRef","in":"query","description":"The client reference of the card to retrieve.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"ExampleCardRef123"},{"name":"customerId","in":"query","description":"The ID of the customer to retrieve cards for.","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"C0000001"},{"name":"currency","in":"query","description":"Currency to get cards for. Expected ISO Standard currency name i.e. GBP, EUR etc","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"GBP"},{"name":"customFieldKey","in":"query","description":"Custom Field Key to get cards for","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"BookingReference"},{"name":"customFieldValue","in":"query","description":"Custom Field Value corresponding to the custom field key to get cards for","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"Booking123"},{"name":"accountIds","in":"query","description":"Set of account Ids to retrieve cards for.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true},"example":"A0000001"},{"name":"channelManagerId","in":"query","description":"The Id of the Channel manager","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"M883412312"},{"name":"frequencyUsage","in":"query","description":"How many times a card can be authorised against. This parameter is rejected for physical cards","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["SINGLE_USE","MULTI_USE"]}},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","minimum":0}},{"name":"size","in":"query","description":"Size of page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","maximum":500}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.CardPageResponse"}}}},"204":{"description":"Cards successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.CardPageResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/channelmanager.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/channel-managers/cards/activities":{"get":{"tags":["Channel Manager Card"],"summary":"Retrieve channel manager's card activities","description":"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.","operationId":"channelManagerGetCardActivities","parameters":[{"name":"fromCreatedDate","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"2019-01-01T15:14:38-0000"},{"name":"toCreatedDate","in":"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","required":false,"style":"form","explode":true,"schema":{"type":"string"},"example":"2019-01-01T15:14:38-0000"},{"name":"statuses","in":"query","description":"Activities with possibly multiple statuses equal to this value. Omitting this is equivalent to supplying all values","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["DECLINED","APPROVED","SETTLED","EXPIRED","APPLIED","PENDING"]}},{"name":"types","in":"query","description":"Activities with possibly multiple types equal to this value. Omitting this is equivalent to supplying all values","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["AUTHORISATION","REVERSAL","SETTLEMENT","REFUND","ORIGINAL_CREDIT","OFFLINE_TRANSACTION","ASI","CREDIT_AUTH","CREDIT_AUTH_REV"]}},{"name":"cards","in":"query","description":"Activities with possibly multiple card IDs equal to this value. Only one of 'cards' or 'accounts' must be supplied","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"accounts","in":"query","description":"Activities with possibly multiple account IDs equal to this value. Only one of 'cards' or 'accounts' must be supplied","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"ids","in":"query","description":"Activities with the specified IDs. Only 'page' and/or 'size' may be used in conjunction with this filter.","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"orderId","in":"query","description":"Activites with specified Order Id","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"channelManagerId","in":"query","description":"Id of channel manager to return activities for","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"sortFields","in":"query","description":"A list of fields to sort the response by. Sorting will be applied in the order the fields are given","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["createdDate","orderId"]}},{"name":"sortOrders","in":"query","description":"A list of orders to apply to the respective sortFields. The only accepted sortOrders will be ASC and DESC (case insensitive)","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["ASC","DESC"]}},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","minimum":0}},{"name":"size","in":"query","description":"Size of page to fetch","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","maximum":500}}],"responses":{"200":{"description":"Card activity data returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.CardActivityPageResponse"}}}},"400":{"description":"Invalid request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/channelmanager.MessageResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/channel-managers/card-reports":{"get":{"tags":["Channel Manager Card"],"summary":"Retrieve channel manager's card reports","description":"Retrieve card reports owned by the channel manager","operationId":"channelManagerSearchCardReports","parameters":[{"name":"fromReportDate","in":"query","description":"Retrieve reports equal to or after this date","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Retrieve reports equal to or after this date","example":"2023-01-01"},"example":"2023-01-01"},{"name":"toReportDate","in":"query","description":"Retrieve reports equal to or before this date","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Retrieve reports equal to or before this date","example":"2023-01-30"},"example":"2023-01-30"},{"name":"reportTypes","in":"query","description":"Report types","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/channelmanager.reportTypes"},"example":"DAILY_CARD_ACTIVITY"},{"name":"reportSubjectIds","in":"query","description":"Report subject Ids (Customer BID, Partner BID or Channel Manager BID)","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/channelmanager.reportSubjectIds"},"example":"C1000001"},{"name":"page","in":"query","description":"Page to fetch (0 indexed)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0,"description":"Page to fetch (0 indexed)","minimum":0}},{"name":"size","in":"query","description":"The size of the page(s)","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","description":"The size of the page(s)","maximum":500,"minimum":1}},{"name":"sortField","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","pattern":"(reportDate|reportType)"}},{"name":"sortOrder","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","pattern":"(asc|desc)"}}],"responses":{"200":{"description":"Card reports retrieved successfully ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.ReportPageResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/channelmanager.MessageResponse"}}}}},"403":{"description":"Unauthorised request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/channelmanager.ReportPageResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/channel-managers/card-reports/{reportId}/report":{"get":{"tags":["Channel Manager Card"],"summary":"Channel Manager download a specific card report","description":"Download a specific card report","operationId":"channelManagerRetrieveReport","parameters":[{"name":"reportId","in":"path","description":"ID of the report to retrieve","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Card report retrieved successfully","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/channelmanager.MessageResponse"}}}}},"403":{"description":"Forbidden. Token may be missing or invalid","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Card report not found","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/compliance/tax-identifiers":{"put":{"tags":["Customers"],"summary":"Create or update a customer’s tax identifiers","description":"Creates or updates a customer’s tax identifiers, please provide list of countries where applicable","operationId":"updateTaxIdentifiersByCustomerId","parameters":[{"name":"customerId","in":"path","description":"ID of customer","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.TaxIdentifiersRequest"}}},"required":true},"responses":{"204":{"description":"OK"},"400":{"description":"Invalid Parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.MessageResponse"}}}}},"403":{"description":"Incorrect permissions"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/compliance/identification-info":{"put":{"tags":["Customers"],"summary":"Create or update customer identification information","description":"Creates or updates customer identification information, such as national or legal entity identifiers","operationId":"updateCustomerIdentificationInfosByCustomerId","parameters":[{"name":"customerId","in":"path","description":"ID of customer","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.CustomerIdentificationInformationRequest"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid Parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.MessageResponse"}}}}},"403":{"description":"Incorrect permissions"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/compliance/associates/{associateId}/tax-residencies":{"put":{"tags":["Customers"],"summary":"Create or update the list of countries where an associate is considered tax-resident","description":"Creates or updates the list of countries where an associate is considered tax-resident, supporting compliance with CRS/FATCA and local tax rules","operationId":"updateTaxResidenciesForAssociate","parameters":[{"name":"customerId","in":"path","description":"ID of customer","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"associateId","in":"path","description":"ID of associate","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.TaxResidenciesRequest"}}},"required":true},"responses":{"204":{"description":"OK"},"400":{"description":"Invalid Parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.MessageResponse"}}}}},"403":{"description":"Incorrect permissions"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/compliance/associates/{associateId}/tax-identifiers":{"put":{"tags":["Customers"],"summary":"Create or update tax identifiers for an associate","description":"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","operationId":"updateTaxIdentifiersForAssociate","parameters":[{"name":"customerId","in":"path","description":"ID of customer","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"associateId","in":"path","description":"ID of associate","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.TaxIdentifiersRequest"}}},"required":true},"responses":{"204":{"description":"OK"},"400":{"description":"Invalid Parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.MessageResponse"}}}}},"403":{"description":"Incorrect permissions"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/compliance/associates/{associateId}/personal-info":{"put":{"tags":["Customers"],"summary":"Create or update an associate’s personal details","description":"Creates or updates an associate’s personal details, such as birth data, nationality, and sex","operationId":"updatePersonalInformationForAssociate","parameters":[{"name":"customerId","in":"path","description":"ID of customer","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"associateId","in":"path","description":"ID of associate","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.PersonalInformation"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Invalid Parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.MessageResponse"}}}}},"403":{"description":"Incorrect permissions"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/compliance/associates/{associateId}/fr/department":{"put":{"tags":["Customers"],"summary":"Create or update the department code for an associate","description":"Creates or updates the department code for individuals residing in France","operationId":"updateDepartmentForAssociate","parameters":[{"name":"customerId","in":"path","description":"ID of customer","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"associateId","in":"path","description":"ID of associate","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.Department"}}},"required":true},"responses":{"204":{"description":"No content"},"400":{"description":"Invalid Parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.MessageResponse"}}}}},"403":{"description":"Incorrect permissions"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/compliance/associates/{associateId}/document-details":{"put":{"tags":["Customers"],"summary":"Create or update identification document details for an associate","description":"Creates or updates identification document details for an associate. Captures official document data used for verification and compliance checks","operationId":"updateIdentificationDocumentsDetailsForAssociate","parameters":[{"name":"customerId","in":"path","description":"ID of customer","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"associateId","in":"path","description":"ID of associate","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.DocumentDetailsRequest"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid Parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.MessageResponse"}}}}},"403":{"description":"Incorrect permissions"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/applications/{applicationId}/compliance/know-your-customer":{"put":{"tags":["Customers"],"summary":"Create or Update Know Your Customer Data for a Customer Application","description":"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.","operationId":"updateKnowYourCustomerByApplicationId","parameters":[{"name":"applicationId","in":"path","description":"ID of application","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.KnowYourCustomer"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Invalid Parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.MessageResponse"}}}}},"403":{"description":"Incorrect permissions"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/applications/{applicationId}/compliance/associates/{associateId}/tax-residencies":{"put":{"tags":["Customers"],"summary":"Create or Update Tax Residency Information for an Application Associate","description":"Creates or updates the list of countries where an individual/associate is considered tax-resident, supporting compliance with CRS/FATCA and local tax rules.","operationId":"updateTaxResidenciesForAssociate_1","parameters":[{"name":"applicationId","in":"path","description":"ID of application","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"associateId","in":"path","description":"ID of associate","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.TaxResidenciesRequest"}}},"required":true},"responses":{"204":{"description":"OK"},"400":{"description":"Invalid Parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.MessageResponse"}}}}},"403":{"description":"Incorrect permissions"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/applications/{applicationId}/compliance/associates/{associateId}/personal-info":{"put":{"tags":["Customers"],"summary":"Create or Update Personal Details for an Application Associate","description":"Creates or updates an individual/associate's personal details for the specified application, such as birth data, nationality, and sex.","operationId":"updatePersonalInformationForAssociate_1","parameters":[{"name":"applicationId","in":"path","description":"ID of application","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"associateId","in":"path","description":"ID of associate","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.PersonalInformation"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Invalid Parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.MessageResponse"}}}}},"403":{"description":"Incorrect permissions"}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/applications/{applicationId}/compliance/businesses":{"get":{"tags":["Customers"],"summary":"Get business entity for an Onboarding Application","description":"Retrieves the business entity for the specified application, including key details such as business name, type and company registration number.","operationId":"getBusiness","parameters":[{"name":"applicationId","in":"path","description":"ID of application","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.BusinessResponse"}}}},"400":{"description":"Invalid parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.MessageResponse"}}}}},"403":{"description":"Incorrect permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.BusinessResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Customers"],"summary":"Add a business entity to an Onboarding Application","description":"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.","operationId":"createBusiness","parameters":[{"name":"applicationId","in":"path","description":"ID of application","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.BusinessRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.CreateBusinessResponse"}}}},"400":{"description":"Invalid Parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.MessageResponse"}}}}},"403":{"description":"Incorrect permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.CreateBusinessResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/applications/{applicationId}/compliance/businesses/addresses":{"get":{"tags":["Customers"],"summary":"Get business addresses for an Onboarding Application","description":"Retrieves the business addresses recorded for the business linked to the specified application.","operationId":"getBusinessAddresses","parameters":[{"name":"applicationId","in":"path","description":"ID of application","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0,"minimum":0}},{"name":"size","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":20,"maximum":500,"minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.BusinessAddressesPageResponse"}}}},"400":{"description":"Invalid parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.MessageResponse"}}}}},"403":{"description":"Incorrect permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.BusinessAddressesPageResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.BusinessAddressesPageResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]},"post":{"tags":["Customers"],"summary":"Add a business address to an Onboarding Application","description":"Creates a new business address, of type REGISTERED or TRADING, for the business linked to the specified application.","operationId":"createBusinessAddress","parameters":[{"name":"applicationId","in":"path","description":"ID of application","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.BusinessAddressRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.CreateBusinessAddressResponse"}}}},"400":{"description":"Invalid Parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.MessageResponse"}}}}},"403":{"description":"Incorrect permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.CreateBusinessAddressResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.CreateBusinessAddressResponse"}}}},"409":{"description":"Address already exists for the given type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.CreateBusinessAddressResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/applications/{applicationId}/compliance/associates":{"post":{"tags":["Customers"],"summary":"Add an individual/associated entity to an Onboarding Application","description":"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.","operationId":"createApplicationAssociate","parameters":[{"name":"applicationId","in":"path","description":"ID of application","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.CreateAssociateRequest"}}},"required":true},"responses":{"201":{"description":"CREATED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.AssociateResponse"}}}},"400":{"description":"Invalid Parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.MessageResponse"}}}}},"403":{"description":"Incorrect permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.AssociateResponse"}}}},"404":{"description":"NOT FOUND","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.AssociateResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/customers/{customerId}/associates":{"get":{"tags":["Customers"],"summary":"Get all associates for a customer","operationId":"getAssociatesByCustomer","parameters":[{"name":"customerId","in":"path","description":"ID of the customer","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"searchCriteria","in":"query","required":true,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/customercompliance.AssociateSearchCriteria"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.AssociatePageResponse"}}}},"400":{"description":"Invalid Parameters","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.MessageResponse"}}}}},"403":{"description":"Incorrect permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customercompliance.AssociatePageResponse"}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}},"/verify-payee":{"post":{"tags":["Verification of Payee"],"summary":"Create Verification of Payee (VOP) request","description":"This endpoint allows you to get information on the accuracy of the payee details the user is going to send a payment to.","operationId":"createOutboundVop","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/verificationofpayee.OutboundVopRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/verificationofpayee.OutboundVopResponse"}}}},"400":{"description":"Validation Errors","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/verificationofpayee.OutboundVopErrorResponse"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/verificationofpayee.OutboundVopErrorResponse"}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/verificationofpayee.OutboundVopErrorResponse"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/verificationofpayee.OutboundVopErrorResponse"}}}}}},"security":[{"HMAC":[]},{"TOKEN":[]}]}}},"components":{"schemas":{"account.IdentifierResponse":{"type":"object","description":"Account Identifier","properties":{"type":{"type":"string"},"accountNumber":{"type":"string","description":"Bank account Sort Code","example":"12345678"},"accountType":{"type":"string","description":"Bank account type like PERSONAL/BUSINESS","enum":["PERSONAL","BUSINESS"]},"sortCode":{"type":"string","description":"Bank account Sort Code","example":"000000"},"iban":{"type":"string","example":"GB20MODR04001401100000"},"bic":{"type":"string","example":"MODRGB21"},"currency":{"type":"string","example":"GBP"},"countrySpecificDetails":{"$ref":"#/components/schemas/account.IdentifierCountrySpecificDetailsResponse","example":{"branchCode":"123456789"}},"productId":{"type":"string","example":"O2100001"}}},"account.BeneficiaryPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/account.BeneficiaryResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}}},"card.ShareSecureCardDetailsRequest":{"type":"object","description":"Share secure card details request","properties":{"shareCardDetails":{"$ref":"#/components/schemas/card.shareDetails"}}},"payment.BatchPaymentsResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/payment.BatchPayment"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0-based, i.e first page = 0, second page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"pispgateway.VrpConfirmationOfFundsResponse":{"type":"object","properties":{"fundsAvailable":{"type":"boolean","description":"The result of funds availability check, can be one of 'true' or 'false'"},"fundsAvailabilityCheckDateTime":{"type":"string","format":"date-time","description":"The time that the funds availability check occurred"}}},"account.BeneficiaryLockPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/account.BeneficiaryLockResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}}},"account.ScreeningResultsResponse":{"type":"object","properties":{"adverseMedia":{"type":"array","items":{"type":"string"}},"peps":{"type":"array","items":{"type":"string"}},"sanctions":{"type":"array","items":{"type":"string"}}}},"pispgateway.CreatePaymentInitiationResponse":{"type":"object","description":"Response object to Initiate Payment","properties":{"paymentInitiationId":{"type":"string","description":"The unique identifier of the payment initiation request at Modulr","example":"I000000001"},"redirectUrl":{"type":"string","description":"A redirect URL for the user to authorise the payment initiation request at the ASPSP","example":"https://www.bankofmoney.com/authorize"}}},"card.UpdateCardHolder":{"type":"object","properties":{"billingAddress":{"$ref":"#/components/schemas/card.AddressDetail","description":"Billing address for the card holder. Must be NULL for individual customers."},"shippingAddress":{"$ref":"#/components/schemas/card.AddressDetail","description":"Shipping address details for card. Optional for individual customers whose partner has verification type EXTERNAL"},"dateOfBirth":{"type":"string","format":"date","description":"Cardholder date of birth. Must match date format of yyyy-mm-dd. Required for virtual consumer and physical cards. Must be NULL for individual customers.","example":"2001-01-01"},"mobileNumber":{"type":"string","description":"Cardholder mobile number. Must start with a '+', followed by the country code and then the mobile number. Required for virtual consumer and physical cards.","example":"+447123456000"},"email":{"type":"string","format":"email","description":"Cardholder email","example":"cardholder@example.com","maxLength":50,"minLength":0}}},"account.AccessGroupResponse":{"type":"object","description":"AccessGroup","properties":{"id":{"type":"string","description":"Unique ID for the access group","example":"G0000001"},"name":{"type":"string","description":"Access group name"},"type":{"type":"string","description":"The type of access group","enum":["SERVICE_PARTNER","SERVICE_CUSTOMER","DELEGATE","USER_DEFINED"]},"typeId":{"type":"string","description":"The identifier of the linked entity implied by the type, e.g. the partner ID"},"status":{"type":"string","description":"Status of the access group","enum":["ACTIVE","DELETED"]},"countOfAccounts":{"type":"integer","format":"int64","deprecated":true,"description":"The number of accounts in this group"}}},"account.JsonNode":{},"customercompliance.DocumentDetail":{"type":"object","properties":{"countryOfIssue":{"type":"string","description":"The issuing country code (ISO Alpha-2)","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"type":{"type":"string","description":"Type of document","enum":["PASSPORT","DRIVING_LICENCE","NATIONAL_IDENTITY_CARD","VOTER_ID","WORK_PERMIT","OTHER_PROOF_OF_IDENTITY"]},"value":{"type":"string","description":"The document number","maxLength":20,"minLength":0}},"required":["value"]},"channelmanager.CardPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/channelmanager.CardResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"integrationnotification.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"onboarding.CreateAssociateRequest":{"type":"object","properties":{"type":{"type":"string","description":"Type of associate","minLength":1},"firstName":{"type":"string","description":"Letters, hyphens and apostrophes","maxLength":100,"minLength":1,"pattern":"^[\\p{L}' -]+$"},"middleName":{"type":"string","description":"Letters, hyphens and apostrophes","pattern":"^[\\p{L}' -]*$"},"lastName":{"type":"string","description":"Letters, hyphens and apostrophes","maxLength":100,"minLength":1,"pattern":"^[\\p{L}' -]+$"},"dateOfBirth":{"type":"string","description":"Date in yyyy-MM-dd format. If associate is a non-applicant director or partner, then partial DOB of yyyy-MM format is allowed. Valid age is from 16 to 150 years. If Applicant then minimum age required is 18 years for specific partners. Required for all associate types except PCM_INDIVIDUAL."},"ownership":{"type":"integer","format":"int32","description":"Ownership percentage for Partners","maximum":100,"minimum":1},"homeAddress":{"$ref":"#/components/schemas/onboarding.AddressRequest","description":"Home address"},"applicant":{"type":"boolean","description":"Indicates if the associate is the applicant. Only one associate can be marked as such."},"email":{"type":"string","description":"Contact email address for applicants","maxLength":100,"minLength":0,"pattern":"[^\\s@]+@[^\\s@]+\\.[^\\s@]+"},"phone":{"type":"string","description":"Contact phone number for applicants, will be formatted into international number pattern"},"documentInfo":{"type":"array","description":"Information on uploaded documents","items":{"$ref":"#/components/schemas/onboarding.DocumentInfo"}},"additionalIdentifiers":{"type":"array","description":"Additional identifiers","items":{"$ref":"#/components/schemas/onboarding.AdditionalAssociateIdentifier"}},"complianceData":{"$ref":"#/components/schemas/onboarding.AssociateComplianceDataRequest","description":"Optional for associates of type C_INTEREST and an EU customer legal entity. Mandatory for associates of type PREQUALIFIED. Not to be set for other associate types and/or for UK customer legal entity."},"complianceId":{"type":"string","description":"Application Associate Compliance ID"},"taxIdentifiers":{"type":"array","description":"Tax identifiers for the associate","items":{"$ref":"#/components/schemas/onboarding.TaxIdentifier"}},"taxResidencies":{"type":"array","description":"Tax residencies for the associate","items":{"type":"string"}},"documentDetails":{"type":"array","description":"Document details for the associate","items":{"$ref":"#/components/schemas/onboarding.DocumentDetail"}},"departmentCode":{"type":"string","description":"Department code for the associate"},"placeOfBirth":{"$ref":"#/components/schemas/onboarding.PlaceOfBirth","description":"Place of birth of the associate"},"sex":{"type":"string","description":"Biological sex","enum":["MALE","FEMALE"]},"nationalities":{"type":"array","items":{"type":"string","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]}}},"required":["firstName","homeAddress","lastName","type"]},"integrationnotification.PaginatedWebhookFailureResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of failed webhook delivery records","items":{"$ref":"#/components/schemas/integrationnotification.WebhookFailureResponse"}},"size":{"type":"integer","format":"int32","description":"Number of records returned in the current page"},"totalSize":{"type":"integer","format":"int64","description":"Total number of matching failure records"},"page":{"type":"integer","format":"int32","description":"Current page number (0-based)"},"totalPages":{"type":"integer","format":"int32","description":"Total number of pages available"}}},"account.AccountPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/account.AccountResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}}},"account.CreateAccountRequest":{"type":"object","description":"Details of account to create","properties":{"externalReference":{"type":"string","description":"External Reference can only have alphanumeric characters plus underscore, hyphen and space up to 50 characters long","maxLength":50,"minLength":0,"pattern":"[\\w \\-]*"},"currency":{"type":"string","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"productCode":{"type":"string","description":"Product associated with the account. Contact your account manager for correct code to use."},"identifier":{"$ref":"#/components/schemas/account.CreateAccountIdentifier","description":"The identifier to assign to the account. Only available to selected partners."}},"required":["currency"]},"pispgateway.StandingOrderPaymentAmount":{"type":"object","description":"The amount of the standing order","properties":{"currency":{"type":"string","description":"Currency of the account in ISO 4217 format. Default is GBP","enum":["GBP"]},"recurringAmount":{"type":"number","description":"Recurring amount of the payment in Major Currency Units - '1' = 1.00 GBP","example":"100.00","maximum":2147483647,"minimum":0.01}},"required":["currency","recurringAmount"]},"pispgateway.MerchantDetails":{"type":"object","description":"Merchant details for the payment context","properties":{"categoryCode":{"type":"string","description":"Merchant category code conform to ISO 18245, related to the type of services or goods provided for the transaction. Must be specified if paymentContextCode is either ECOMMERCEGOODS or ECOMMERCESERVICES","maxLength":4,"minLength":3},"customerId":{"type":"string","description":"Merchant customer identification, must be specified if paymentContextCode is either ECOMMERCEGOODS or ECOMMERCESERVICES","maxLength":70,"minLength":1}}},"channelmanager.AuthInfo":{"type":"object","properties":{"type":{"type":"string","description":"Transaction type","minLength":1},"inputMethod":{"type":"string","description":"Input method","minLength":1}},"required":["inputMethod","type"]},"account.CustomerComplianceDataRequest":{"type":"object","properties":{"typeDescription":{"type":"string","description":"Required for customers of type PREQUALIFIED. Not allowed for all other customer types.","maxLength":200,"minLength":0},"riskLevel":{"type":"string","description":"Risk level of the customer","enum":["LOW","MEDIUM","HIGH","UNDETERMINED"]},"vulnerabilityReasons":{"type":"array","description":"Vulnerability Reasons of the customer","items":{"type":"string","enum":["LIFE_EVENTS","HEALTH","RESILIENCE","CAPABILITY","FINANCIAL_DIFFICULTY"]}},"business":{"$ref":"#/components/schemas/account.BusinessDataRequest","description":"Business data of the customer"},"consumer":{"$ref":"#/components/schemas/account.ConsumerDataRequest","description":"Consumer data of the customer"}}},"payment.NameCheck":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of name check result","example":"PAV2322342"},"source":{"type":"string","description":"Origin of the name check result, could be MODULR or EXTERNAL","enum":["MODULR","EXTERNAL"],"example":"MODULR"}},"required":["id"]},"payment.currency":{"type":"array","items":{"type":"string","description":"Currency of the payment in ISO 4217 format, multiple currencies can be specified by repeating the parameter.","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"pispgateway.VrpConsentResponse":{"type":"object","description":"Response object of VRP Consent","properties":{"aspspId":{"type":"string","description":"Identifier of the payer’s ASPSP where the consent will be created. The ASPSP must have the \"SWEEPING\" or \"COMMERCIAL\" capability enabled (which can be checked using our API).","example":"H100000001"},"destination":{"$ref":"#/components/schemas/pispgateway.Destination","description":"Destination account details that will receive variable recurring payments initiated using this consent."},"paymentConstraints":{"$ref":"#/components/schemas/pispgateway.PaymentConstraints","description":"Limits that will apply to payments initiated using this consent."},"reference":{"type":"string","description":"Reference to be used for the Consent. This will appear on the Account statement/the recipient's bank account. Min 6 to max 18 characters. Can contain alphanumeric, '-', '.', '&', '/' and space.","example":"Invoice ABC123"},"validFromDate":{"type":"string","format":"date-time","description":"Start date time from which payments can be initiated using this consent. Must be specified using YYYY-MM-DDTHH:mm:ssZ format.","example":"2022-01-31T20:16:01.90Z"},"validToDate":{"type":"string","format":"date-time","description":"End date time after which payments cannot be initiated using this consent. Must be specified using YYYY-MM-DDTHH:mm:ssZ format.","example":"2022-07-31T20:16:01.90Z"},"type":{"type":"string","description":"Type of VRP consent that will be created.","enum":["SWEEPING","CVRP1"]},"status":{"type":"string","description":"The current status of the VRP consent.","enum":["AWAITING_AUTHORISATION","AUTHORISED","REJECTED","REVOKED","ER_GENERAL","ER_EXTSYS"]},"interactionTypes":{"type":"array","description":"List of PSU interaction types permitted under this consent. Must be one or both of IN_SESSION (customer is present), OFF_SESSION (customer is not present)","items":{"type":"string","enum":["IN_SESSION","OFF_SESSION"]}},"ultimateCreditor":{"$ref":"#/components/schemas/pispgateway.UltimateParty","description":"The ultimate beneficiary of the payment, party to which an amount of money is due. Provided if different from the immediate creditor."},"ultimateDebtor":{"$ref":"#/components/schemas/pispgateway.UltimateParty","description":"The ultimate payer, party that owes an amount of money to the (ultimate) creditor. Provided if different from the account holder."},"risk":{"$ref":"#/components/schemas/pispgateway.OBRisk","description":"Additional details used for risk scoring for Payments."}},"required":["aspspId","destination","paymentConstraints","reference","status","type"]},"card.CardCustomFieldKeyResponse":{"type":"object","properties":{"key":{"type":"string","description":"Custom field key"},"required":{"type":"boolean","description":"Whether the custom field is required or not"}}},"customercompliance.AssociateAdditionalIdentifier":{"type":"object","description":"Additional personal identifier","properties":{"type":{"type":"string","description":"Type of additional personal identifier","enum":["BSN"]},"value":{"type":"string","description":"Identifier value","minLength":1}},"required":["type","value"]},"card.ResetCardPinRequest":{"type":"object","description":"Reset PIN","properties":{"currentPin":{"type":"string","description":"Card's current PIN required to reset","minLength":1,"pattern":"^[0-9]{4}$"},"newPin":{"type":"string","description":"Card's new PIN to update","minLength":1,"pattern":"^[0-9]{4}$"}},"required":["currentPin","newPin"]},"channelmanager.JsonNode":{},"account.BeneficiaryResponse":{"type":"object","description":"Beneficiary","properties":{"id":{"type":"string","description":"Unique reference for the Beneficiary.","example":"B00000001A"},"name":{"type":"string","description":"Name for the Beneficiary"},"birthdate":{"type":"string","format":"date","description":"Date of birth for the Beneficiary in yyyy-MM-dd format"},"emailAddress":{"type":"string","description":"Email address for the Beneficiary"},"phoneNumber":{"type":"string","description":"Phone number for the Beneficiary in international pattern"},"destinationIdentifier":{"$ref":"#/components/schemas/account.IdentifierResponse"},"redirectedDestination":{"$ref":"#/components/schemas/account.IdentifierResponse","description":"Provides new account details where the beneficiary's account details have been redirected by the scheme."},"defaultReference":{"type":"string","description":"Default reference used for payments to the Beneficiary."},"status":{"type":"string","description":"Status of the Beneficiary. Can be:"},"created":{"type":"string","format":"date-time","description":"Datetime the Beneficiary was created.Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000"},"accountId":{"type":"string","description":"Id of the account if this beneficiary is a Modulr account, null otherwise"},"externalReference":{"type":"string","description":"External system reference for the Beneficiary"},"approvalRequired":{"type":"boolean","description":"Indicates if the beneficiary creation is pending approval"},"customerId":{"type":"string","description":"Id of the customer than owns this beneficiary","example":"C0000001"},"updated":{"type":"string","format":"date-time","description":"Datetime the Beneficiary was last updated.Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000"},"address":{"$ref":"#/components/schemas/account.AddressResponse","description":"address of the beneficiary"},"qualifier":{"type":"string","description":"Qualifier for this beneficiary"},"approvalRequestId":{"type":"string","description":"Approval request ID for pending records."},"approvalStatus":{"type":"string","description":"Approval status of item.","enum":["NOTNEEDED","PENDING","APPROVED","REJECTED","DELETED"]},"accessGroups":{"type":"array","description":"Access groups associated with beneficiary.","items":{"type":"string"},"uniqueItems":true},"createdBy":{"type":"string","description":"System or person who created the beneficiary"}}},"channelmanager.SpendConstraintDetail":{"type":"object","description":"Spending constraints","properties":{"currency":{"type":"string","description":"A 3 letter ISO 4217 code representing the transaction currency","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"GBP"},"min":{"type":"number","description":"Minimum spend amount (inclusive)","example":"5.00"},"max":{"type":"number","description":"Maximum spend amount (inclusive)","example":"2000.00"}},"required":["currency"]},"payment.PaymentApproval":{"type":"object","description":"A single approval against a batch payment request","properties":{"approvedBy":{"type":"string","description":"ID of user who approved this batch payment request","example":"U2100021"},"approvedOn":{"type":"string","format":"date","description":"Date this approval was applied","example":"2022-06-25"}}},"account.UpdateAccountRequest":{"type":"object","description":"Details of account to edit","properties":{"externalReference":{"type":"string","description":"External Reference can only have alphanumeric characters plus underscore, hyphen and space up to 50 characters long","maxLength":50,"minLength":0,"pattern":"[\\w \\-]*"},"name":{"type":"string","description":"Name for the account, only applicable for 'PCM_INDIVIDUAL' and 'PCM_BUSINESS' customer types","maxLength":40,"minLength":0}}},"card.shareDetails":{"type":"object","properties":{"method":{"type":"string","description":"Method to share secure card details. Can be one of RETURN or EMAIL. Will default to EMAIL if not provided.","enum":["RETURN","EMAIL"]},"emails":{"type":"array","description":"Emails to share secure card details with. Optional: Required if no method provided or if method EMAIL. Must be null for method RETURN","items":{"type":"string","format":"email"},"maxItems":50,"minItems":0},"noOfLinkAccesses":{"type":"integer","format":"int64","description":"Number of times token/link shared will be accessible. Default of 3"},"expiryDate":{"type":"string","format":"date","description":"Date of expiry of the secure card details link should be default of 15 days. Must match date format of yyyy-mm-dd and be in the future.","example":"2026-01-01"},"otherDetailsToShare":{"type":"array","description":"List of other card details to share. Will be validated against fields in card response. Default is nothing.","items":{"type":"string"}},"message":{"type":"string","description":"Message to be shared with the details. Only alphanumeric characters maximum of 200 and allowed chars -/:€$£#¢%().,!@","maxLength":200,"minLength":0,"pattern":"^[a-zA-Z0-9\\-/:€$£#¢%().,!@ ]*$"},"externalReference":{"type":"string","description":"External reference for the shared secure detail link","maxLength":50,"minLength":1,"pattern":"[\\w -]*"}}},"verificationofpayee.OutboundVopErrorResponse":{"type":"object","description":"Verify Payee Error Response","properties":{"field":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"},"errorCode":{"type":"string"}},"required":["code","message"]},"customercompliance.BusinessResponse":{"type":"object","properties":{"id":{"type":"string","description":"Business ID"},"type":{"type":"string","description":"Business type","enum":["LLC","PLC","LLP","PARTNERSHIP","SOLETRADER"]},"registeredName":{"type":"string","description":"Registered business name"},"registrationNumber":{"type":"string","description":"Company registration number"}}},"directdebit.IndemnityClaimStatusHistoryResponse":{"type":"object","properties":{"changeDate":{"type":"string","format":"date"},"schemeId":{"type":"string"},"status":{"type":"string","enum":["NEW","CANCELLED","SETTLED"]}}},"directdebit.MandatePageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/directdebit.Mandate"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0-based, i.e first page = 0, second page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"onboarding.FinaliseApplicationResponse":{"type":"object","properties":{"id":{"type":"string"}}},"inboundpayment.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"account.id":{"type":"array","description":"ID of Customer(s) to fetch","items":{"type":"string","description":"ID of Customer(s) to fetch"}},"account.AddressRequest":{"type":"object","properties":{"addressLine1":{"type":"string","maxLength":50,"minLength":0},"addressLine2":{"type":"string","maxLength":50,"minLength":0},"postTown":{"type":"string","maxLength":50,"minLength":0},"postCode":{"type":"string","maxLength":10},"country":{"type":"string","description":"Mandatory for international payments."},"countrySubDivision":{"type":"string","maxLength":35,"minLength":0}}},"paymentfileupload.FileCreatePaymentsResponse":{"type":"object","description":"File create payments response","properties":{"fileId":{"type":"string","description":"Unique id of the uploaded file","example":"F1100001","minLength":1},"status":{"type":"string","description":"Status of the uploaded file","enum":["NEW","SUBMITTED","PROCESSING","INVALID","VALID","DUPLICATE","REJECTED","ERROR_RETRYABLE","ACCEPTED","PROCESSED","SENDING","PAYMENT_PROCESSING","SPLIT_FILE","PARTIALLY_ACCEPTED"],"example":"INVALID"},"fileName":{"type":"string","description":"File name of the uploaded file","example":"file1"},"batchPaymentId":{"type":"string","description":"Unique id for the Batch Payment","example":"B1100001","minLength":1}},"required":["batchPaymentId","fileId","status"]},"pispgateway.StandingOrderPayment":{"type":"object","description":"The payment of the standing order","properties":{"destination":{"$ref":"#/components/schemas/pispgateway.Destination","description":"The destination account for the payment"},"amount":{"$ref":"#/components/schemas/pispgateway.StandingOrderPaymentAmount","description":"The amount of the standing order"},"reference":{"type":"string","description":"Reference to be used for the Payment. This will appear on the Account statement/the recipient's bank account. Min 6 to max 18 characters. Can contain alphanumeric, '-', '.', '&', '/' and space.","example":"Invoice ABC123","minLength":1}},"required":["amount","destination","reference"]},"customercompliance.BusinessAddressRequest":{"type":"object","properties":{"type":{"type":"string","description":"Business address type","enum":["REGISTERED","TRADING"]},"address":{"$ref":"#/components/schemas/customercompliance.AddressRequest","description":"Business address"}},"required":["address","type"]},"card.BulkCardsOpsResponse":{"type":"object","properties":{"bulkRequestId":{"type":"string"},"submissionTimestamp":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["SUBMITTED","VALIDATED","VALIDATED_WITH_ERRORS","PROCESSING","PARTIALLY_PROCESSED_WITH_ERRORS","PARTIALLY_PROCESSED","PROCESSED","ARCHIVED","DELETED"]}}},"account.AccessGroupRequest":{"type":"object","properties":{"action":{"type":"string","description":"Action to apply for the supplied account bid","enum":["ADD","REMOVE"]},"accountIds":{"type":"array","description":"Bids of the accounts to be added/removed","items":{"type":"string"}},"beneficiaryIds":{"type":"array","description":"Bids of the beneficiaries to be added/removed","items":{"type":"string"}},"name":{"type":"string","description":"The name of the account group to create. Must match: [\\w \\-]*","maxLength":50,"minLength":0,"pattern":"[\\w \\-]*"}}},"card.CardTokenDevice":{"type":"object","properties":{"id":{"type":"string","description":"Device ID","example":"D110000001"},"type":{"type":"string","description":"Device type","enum":["CLOTHING","MEDIA_GAMING","CARD","DOMESTIC_APPLIANCE","FOB","MOBILE_TAG","FASHION","JEWELRY","MOBILE_PHONE","PERSONAL_COMPUTER","WRISTBAND","STICKER","TABLET","UNKNOWN","VEHICLE","WATCH","MOBILE_PHONE_OR_TABLET"],"example":"MOBILE_PHONE"},"ip":{"type":"string","description":"IPv4 address of the device. Either in hex format (i.e FFFFFFFF) or decimal format (i.e. 255.255.255.255)","example":"255.255.255.255"},"name":{"type":"string","description":"Device name, as given by the cardholder","example":"iPhone 12"},"status":{"type":"string","description":"Device status","enum":["PENDING_PROVISIONING","PROVISIONED","DELETED","UNKNOWN"],"example":"ACTIVE"},"externalId":{"type":"string","description":"Device External Id"}},"required":["externalId","id","ip","name","status","type"]},"directdebitoutbound.CollectionRejectRequest":{"type":"object","description":"Collection reject request","properties":{"claimBId":{"type":"string","description":"Collection Claim Business ID","example":"A123456B","pattern":"[A-Za-z]{1}[0-9]{2}([A-Za-z0-9]){5}"},"rejectCode":{"type":"string","enum":["ADVANCE_NOTICE_DISPUTED","AMOUNT_DIFFERS","AMOUNT_NOT_YET_DUE","PRESENTATION_OVERDUE","SKIP_DEBIT_ATTEMPT"]}},"required":["claimBId","rejectCode"]},"account.ExpectedTransactionalActivityRequest":{"type":"object","properties":{"sourceOfFunds":{"type":"string"},"monthlyVolume":{"type":"integer","format":"int32"},"outboundPaymentJurisdictions":{"type":"array","items":{"type":"string","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]}}}},"account.addressLines":{"type":"array","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","items":{"type":"string","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"},"uniqueItems":true},"channelmanager.reportTypes":{"type":"array","description":"Report types","example":"DAILY_CARD_ACTIVITY","items":{"type":"string","description":"Report types","enum":["DAILY_CARD_ACTIVITY","MONTHLY_CARD_ACTIVITY","DAILY_ACCOUNT_FUNDING","MONTHLY_ACCOUNT_FUNDING","DAILY_AUTH_WINDOW","DAILY_CARD_MANAGEMENT"],"example":"DAILY_CARD_ACTIVITY"}},"payment.OfficialOrganisationIdentity":{"type":"object","properties":{"bankPartyIdentification":{"type":"string","description":"Bank party identification","example":"12345","maxLength":35,"minLength":0},"centralBankIdNumber":{"type":"string","description":"Central bank identification number","example":"678910","maxLength":35,"minLength":0},"clearingIdNumber":{"type":"string","description":"Clearing identification Number","example":"xx15402","maxLength":35,"minLength":0},"certificateOfIncorporationNumber":{"type":"string","description":"Certification of the incorporation number","example":"1100010","maxLength":35,"minLength":0},"countryIdCode":{"type":"string","description":"Country identification code","example":"111111","maxLength":35,"minLength":0},"customerNumber":{"type":"string","description":"Customer number","example":"00221133","maxLength":35,"minLength":0},"dataUniversalNumberingSystem":{"type":"string","description":"Data universal numbering system","example":"002211330","pattern":"^[0-9]{9,9}?$"},"employerIdNumber":{"type":"string","description":"Employer identification number","example":"00221133","maxLength":35,"minLength":0},"gs1glnIdentifier":{"type":"string","description":"GS1GLN identifier","example":"00221133","maxLength":35,"minLength":0},"sirenCode":{"type":"string","description":"SIREN code","example":"00221133","maxLength":35,"minLength":0},"siretCode":{"type":"string","description":"SIRET code","example":"00221133","maxLength":35,"minLength":0},"taxIdNumber":{"type":"string","description":"Tax identification number","example":"00221133","maxLength":35,"minLength":0},"bicIdentifier":{"type":"string","description":"BICI identification","example":"MGALODJAO7A","pattern":"^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}?$"},"ibeiIdentifier":{"type":"string","description":"IBEI identification","example":"HIZFTMTT59","pattern":"^[A-Z]{2,2}[B-DF-HJ-NP-TV-XZ0-9]{7,7}[0-9]{1,1}?$"},"beiIdentifier":{"type":"string","description":"BEI identification","example":"MHIHISVZUMH","pattern":"^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}?$"},"eanglnIdentifier":{"type":"string","description":"EANGLN identification","example":"7516164953429","pattern":"^[0-9]{13,13}?$"},"chipsUniversalIdentifier":{"type":"string","description":"CHIPS universal identification","example":"CH157373","pattern":"^CH[0-9]{6,6}?$"},"genericIdentification3":{"type":"string","description":"Generic identification 3","example":"123456788","maxLength":35,"minLength":0},"genericIdentificationIssr":{"type":"string","description":"Generic identification issr","example":"13143225","maxLength":35,"minLength":0}}},"card.Remove":{"allOf":[{"$ref":"#/components/schemas/card.PatchOperation"}],"description":"Remove field","required":["op","path"]},"card.BulkRequestPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/card.BulkRequestResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"card.Error":{"type":"object","properties":{"operationIndex":{"type":"integer","format":"int64"},"operationId":{"type":"string"},"field":{"type":"string"},"description":{"type":"string"}}},"pispgateway.VrpPaymentRequest":{"type":"object","properties":{"consentId":{"type":"string","description":"The unique identifier of the VRP consent initiation request at Modulr.","example":"E210000004"},"payment":{"$ref":"#/components/schemas/pispgateway.Payment","description":"Payment details for the VRP payment initiation request."},"interactionType":{"type":"string","description":"PSU interaction type permitted under this consent. Must be one of: IN_SESSION (customer is present), OFF_SESSION (customer is not present).","enum":["IN_SESSION","OFF_SESSION"]}},"required":["consentId","payment"]},"paymentfileupload.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"payment.BatchPaymentDetailsResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique id for the Batch Payment. 10 characters long","example":"D920000001"},"externalReference":{"type":"string","description":"External reference, if provided","example":"aReference_00001"},"status":{"type":"string","description":"Current status of batch.","enum":["ACCEPTED","REJECTED","SUBMITTED","CANCELLED"],"example":"ACCEPTED"},"totalPayments":{"type":"integer","format":"int32","description":"Total count of payments in this batch","example":9123},"currentUserCanApprove":{"type":"boolean","description":"Whether the user is allowed to approve this batch, based on their approval limits, and applicable configuration","example":true},"paymentDetails":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/payment.PaymentsSummary"},"description":"Summary of payments and approvals, per currency (as a 3-alpha currency code)"},"approvals":{"type":"array","description":"List of batch-level approvals","items":{"$ref":"#/components/schemas/payment.PaymentApproval"}},"currentUserCanCancel":{"type":"boolean","description":"Whether the user is allowed and currently able to cancel at least one of the payments in this batch"},"createdDate":{"type":"string","format":"date-time","description":"Datetime when the batch payment was created. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000"},"createdBy":{"type":"string","description":"ID of the user that created the payment"},"processingDateFrom":{"type":"string","format":"date","description":"Earliest processing date in the batch file or the batch creation date if the file does not have any dates. Date format 'yyyy-MM-dd'","example":"2017-01-28"},"processingDateTo":{"type":"string","format":"date","description":"Last processing date in the batch file or empty if the file does not have any dates. Date format 'Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000'","example":"2017-01-28"},"earliestScheduledPaymentDate":{"type":"string","format":"date","description":"Earliest processing date in the batch file or empty if the file does not have any dates. Date format 'Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000'","example":"2017-01-28"},"requiredApprovalCount":{"type":"integer","format":"int32","description":"The number of required approvals for the batch.  Applicable to batch payments of submissionType BATCH"},"batchSummary":{"$ref":"#/components/schemas/payment.BatchSummary","description":"Summary of the state of payment requests in this batch"},"strict":{"type":"boolean","description":"Strict processing flag. Whether the entire batch should fail on any individual payment validation failure"},"summary":{"$ref":"#/components/schemas/payment.BatchPaymentSummary","description":"Summary of the state of payment requests in this batch"}}},"onboarding.CreateApplicationRequest":{"type":"object","properties":{"legalEntity":{"type":"string","description":"Modulr Legal Entity that this customer is associated with.","enum":["MFSL","MFBV"]}},"required":["legalEntity"]},"confirmationofpayee.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"onboarding.Customer":{"type":"object","description":"A Customer is a single legal entity that can have 1 or more accounts","properties":{"id":{"type":"string","description":"Unique identifier for a Customer. Begins with 'C'","example":"C00000001"},"name":{"type":"string","description":"Customer's company name - must be unique across the Modulr platform."},"brandNames":{"type":"array","description":"The customers brand name(s)","items":{"$ref":"#/components/schemas/onboarding.BrandNameResponse"}},"type":{"type":"string","description":"Type of the customer, 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. CHARITY -> charity\n8. INDIVIDUAL -> individual consumer\n9. PCM_INDIVIDUAL -> partner clearing model individual consumer\n10. PCM_BUSINESS -> partner clearing model business consumer"},"status":{"type":"string","description":"Status of the Customer. Customers must be 'Active' for Accounts to be created for them.","enum":["ACTIVE","CLOSED","BLOCKED"]},"verificationStatus":{"type":"string","description":"How the identity of the Customer has been verified. Can be:\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"},"companyRegNumber":{"type":"string","description":"The company registration / incorporation number of the company. Only applicable for companies registered with Companies House"},"expectedMonthlySpend":{"type":"integer","format":"int32","description":"Indication of the monthly spend of the customer."},"registeredAddress":{"$ref":"#/components/schemas/onboarding.AddressResponse","description":"The address of the company's registered office."},"tradingAddress":{"$ref":"#/components/schemas/onboarding.AddressResponse","description":"The address of the company's day-to-day trading activities."},"partnerId":{"type":"string","description":"The owning partner identifier"},"associates":{"type":"array","description":"Array of associate objects that link to the Customer. For example, this could contain the details of the company directors for a Limited company, or or the partners for a partnership.","items":{"$ref":"#/components/schemas/onboarding.AssociateResponse"}},"industryCode":{"type":"string"},"tcsVersion":{"type":"integer","format":"int32","description":"Version of the Modulr Account Terms and Conditions the Customer has agreed to."},"documentInfo":{"type":"array","description":"Array of document objects that relate to the Customer being created. Examples of Documents could be proof of a Company Director's identity or address, Articles of Association or a Partnership Agreement.","items":{"$ref":"#/components/schemas/onboarding.DocumentInfo"}},"externalReference":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Datetime when the customer was created.Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000"},"delegate":{"$ref":"#/components/schemas/onboarding.DelegateResponse","description":"Details of this Customer's linked Delegate"},"legalEntity":{"type":"string","description":"Legal entity of the customer","enum":["GB","NL","IE"]},"customerTrust":{"$ref":"#/components/schemas/onboarding.CustomerTrustResponse","description":"Trust nature for customers of type trust. Mandatory for type Trust, not to be set for non-trust customers."},"taxProfile":{"$ref":"#/components/schemas/onboarding.CustomerTaxProfileResponse","description":"Tax profile for customers of type SOLETRADER. Optional for type SOLETRADER, not to be set for non-SOLETRADER customers."},"complianceData":{"$ref":"#/components/schemas/onboarding.CustomerComplianceDataResponse","description":"Required for customers of type PREQUALIFIED. Not allowed for all other customer types."},"complianceSector":{"type":"string","example":"Agency Lite Consumer"},"generateStatements":{"type":"boolean","description":"True if the customer is configured to generate statements"},"taxIdentifiers":{"type":"array","description":"Tax Identifiers for the customer","items":{"$ref":"#/components/schemas/onboarding.TaxIdentifier"}}},"required":["createdDate","id","name","status","type","verificationStatus"]},"customercompliance.DocumentDetailsRequest":{"type":"object","properties":{"documentDetails":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.DocumentDetail"}}}},"pispgateway.CreatePaymentInitiationRequest":{"type":"object","description":"Request object to Initiate Payment","properties":{"paymentAmount":{"$ref":"#/components/schemas/pispgateway.PaymentAmount","description":"The amount of the payment"},"paymentReference":{"type":"string","description":"Reference to be used for the Payment. This will appear on the Account statement/the recipient's bank account. Min 6 to max 18 characters. Can contain alphanumeric, '-', '.', '&', '/' and space.","example":"Invoice ABC123","minLength":1},"destination":{"$ref":"#/components/schemas/pispgateway.Destination","description":"The destination account for the payment"},"aspspId":{"type":"string","description":"Identifier for ASPSP being used for the payment","example":"H100000001","minLength":1},"paymentContext":{"$ref":"#/components/schemas/pispgateway.LegacyPaymentContext","description":"Payment context used to specify additional details for risk scoring"}},"required":["aspspId","destination","paymentAmount","paymentReference"]},"account.state":{"type":"array","description":"Approval item state(s) to filter by","items":{"type":"string","description":"Approval item state(s) to filter by"}},"card.CancelCardRequest":{"type":"object","description":"Reason for cancellation","properties":{"reason":{"type":"string","description":"The reason for cancelling the card. Can be one of DESTROYED, LOST, STOLEN","enum":["STOLEN","DESTROYED","LOST"]}}},"channelmanager.CardEnquiryRequest":{"type":"object","description":"Enquiry","properties":{"pan":{"type":"string","description":"pan"},"providerSuppliedId":{"type":"string","description":"providerSuppliedId"}}},"account.statuses":{"type":"array","items":{"type":"string","default":"ACTIVE","description":"Account statuses","enum":["ACTIVE","BLOCKED","CLOSED","CLIENT_BLOCKED"]}},"directdebit.Collection":{"type":"object","properties":{"id":{"type":"string","description":"Unique id for a direct-debit collection","example":"K000100100"},"mandateId":{"type":"string","description":"Unique id for direct-debit mandate.","example":"G0000001"},"collectionScheduleId":{"type":"string","description":"Unique id for direct-debit collection schedule for which triggered the collection","example":"Q9200001"},"activityDate":{"type":"string","description":"collection or reportRaised date for indemnity???","example":"2018-01-09"},"amount":{"type":"number","description":"Amount of the collection payment","example":"100.00"},"type":{"type":"string","description":"Type of the collection activity.  Can be one of ","example":"COLLECTION"},"payerName":{"type":"string","description":"Name of the payer","example":"Mr John Doe"},"status":{"type":"string","description":"Status of the collection.  Can be one of ","example":"FAILED"},"message":{"type":"string","description":"Failure description of the payment activity","example":"Instruction Cancelled"},"originalActivityDate":{"type":"string","description":"The original scheduled date for a payment to be collected","example":"2018-01-09"},"reconciliationDate":{"type":"string","description":"The reconciled date for a payment to be collected","example":"2018-01-09"},"reconciliationReference":{"type":"string","description":"The reconciled reference that links to a payment","example":"2018-01-09"},"ddiReference":{"type":"string","description":"collectionReference - if present - is appended to the original DDI reference\n(used during mandate creation - referred to as core reference) for the specified scheduled collection\nwithout altering the original mandate core reference. This will be visible to the payer on their account.\nThe reference and collectionReference combined have 18 character limit and can only contain alphanumeric\ncharacters with underscore, hyphen and space permitted","example":"ABCD-EFGH"}},"required":["activityDate","amount","id","mandateId","message","originalActivityDate","payerName","reconciliationDate","reconciliationReference","status","type"]},"cardsimulator.CardAccountStatusInquiryRequest":{"type":"object","description":"Details of the account status inquiry","properties":{"transactionAmount":{"type":"number","description":"The transaction amount","example":"5.45"},"transactionCurrency":{"type":"string","description":"The transaction currency. Defaults to the card's billing currency","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"GBP"},"fxRate":{"type":"number","description":"The foreign exchange rate to use, when transaction currency differs from billing currency. Defaults to 1.0","example":"0.8"},"mcc":{"type":"string","description":"Merchant Category Code","example":"5812"}},"required":["mcc","transactionAmount"]},"channelmanager.AuthorisationWindowRequest":{"type":"object","properties":{"startDate":{"type":"string","example":"2025-01-01"},"endDate":{"type":"string","example":"2025-01-01"}}},"confirmationofpayee.JsonOutboundCopResponse":{"type":"object","description":"Account Name Check Response","properties":{"id":{"type":"string","description":"Unique id for the account name check.","example":"C12001569Z"},"result":{"$ref":"#/components/schemas/confirmationofpayee.JsonOutboundCopResult","description":"The result of the account name check."}},"required":["id","result"]},"directdebit.Address":{"type":"object","properties":{"addressLine1":{"type":"string","maxLength":150,"minLength":0},"addressLine2":{"type":"string","maxLength":150,"minLength":0},"postTown":{"type":"string","maxLength":150,"minLength":0},"postCode":{"type":"string","maxLength":8,"minLength":0},"country":{"type":"string","minLength":1}},"required":["addressLine1","country","postCode","postTown"]},"customercompliance.AddressRequest":{"type":"object","properties":{"addressLine1":{"type":"string","description":"Address line 1","minLength":1},"addressLine2":{"type":"string","description":"Address line 2"},"country":{"type":"string","description":"Country alpha2 code","minLength":1},"postCode":{"type":"string","description":"Post code","minLength":1},"postTown":{"type":"string","description":"Post town","minLength":1}},"required":["addressLine1","country","postCode","postTown"]},"card.CardResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card identifier. Maximum of 10 alphanumeric characters","example":"V000000001"},"holder":{"$ref":"#/components/schemas/card.CardHolder","description":"CardHolder"},"expiry":{"type":"string","description":"An ISO 8601 date with year & month components only","example":"2018-12"},"status":{"type":"string","description":"The current state of the card."},"currency":{"type":"string","description":"A 3 letter ISO 4217 code representing the card currency","example":"GBP"},"limit":{"type":"string","description":"Total card authorisation limit","example":"1000.00"},"maxLimit":{"type":"string","description":"Maximum limit which can be set on this card and is the maximum lifetime spend the card can have","example":"4000.00"},"spend":{"type":"string","description":"Current total of all authorisations on this card","example":"250.00"},"externalRef":{"type":"string","description":"Client reference for the newly created card. Maximum of 50 characters.","example":"TTQ_51211"},"maskedPan":{"type":"string","description":"Masked card PAN","example":"527095******3544"},"cardType":{"type":"string","description":"Card product type","example":"Business"},"cardScheme":{"type":"string","description":"Card scheme. MASTERCARD or VISA","example":"MASTERCARD"},"accountBid":{"type":"string","description":"Account identifier","example":"A020N8PD"},"productId":{"type":"string","description":"Product identifier","example":"O210003A"},"format":{"type":"string","description":"The format of the card.  PHYSICAL or VIRTUAL","enum":["PHYSICAL","VIRTUAL"],"example":"PHYSICAL"},"constraints":{"$ref":"#/components/schemas/card.CardConstraints","description":"CardConstraints"},"design":{"$ref":"#/components/schemas/card.ProductDesignDetail","description":"External reference for card design. Will only be returned for physical cards"},"printedName":{"type":"string","description":"Name printed on the card. Will only be returned for physical cards. Maximum of 20 alphanumeric characters (including full stop, hyphen, apostrophe, caret and space)"},"cancellationDate":{"type":"string","description":"Date card will be cancelled on","example":"2025-01-01"},"createdDate":{"type":"string","format":"date-time"},"threeDSecureStatus":{"type":"string","deprecated":true,"description":"The 3DS status of the card, based on the SMS one time password","enum":["NOT_ENROLLED","ENROLLED","UNENROLLED"],"example":"ENROLLED"},"authentication":{"$ref":"#/components/schemas/card.CardThreeDSecureAuthentication","description":"The 3DS authentication method statuses"},"shippingAddress":{"$ref":"#/components/schemas/card.AddressDetail","description":"Shipping address"},"customFields":{"type":"array","description":"Custom fields currently defined for card","items":{"$ref":"#/components/schemas/card.CardCustomFieldResponse"}},"authWindow":{"$ref":"#/components/schemas/card.AuthorisationWindow","description":"Authorisation window defined for card"},"channelManagerId":{"type":"string","description":"Channel Manager identifier","example":"M883412312"},"frequencyUsage":{"type":"string","description":"Enum that specifies the frequency usage of the card","enum":["SINGLE_USE","MULTI_USE"],"example":"SINGLE_USE"}}},"payment.AddressRequest":{"type":"object","properties":{"addressLine1":{"type":"string","maxLength":50,"minLength":0},"addressLine2":{"type":"string","maxLength":50,"minLength":0},"postTown":{"type":"string","maxLength":50,"minLength":0},"postCode":{"type":"string","maxLength":10},"country":{"type":"string","description":"Mandatory for international payments."},"countrySubDivision":{"type":"string","maxLength":35,"minLength":0}},"required":["addressLine1","postTown"]},"payment.Charge":{"type":"object","properties":{"bearer":{"type":"string","description":"Information about bearer of the charges. Its can be Creditor, Debtor or shared between both","enum":["CRED","DEBT","SHAR"],"example":"CRED"},"amount":{"type":"number","description":"Amount of the charges. Max allowed is 999999999999.99","example":"100.00"},"currency":{"type":"string","description":"Currency of charge. Should be ISO Standard currency","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"GBP"}},"required":["amount","bearer","currency"]},"card.AuthInfo":{"type":"object","properties":{"type":{"type":"string","description":"Transaction type","minLength":1},"inputMethod":{"type":"string","description":"Input method","minLength":1}},"required":["inputMethod","type"]},"onboarding.PlaceOfBirth":{"type":"object","properties":{"country":{"type":"string","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"city":{"type":"string"}}},"card.CardPinResponse":{"type":"object","properties":{"pin":{"type":"string","description":"Card PIN","example":"0123"}}},"channelmanager.CreateCardResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card identifier. Maximum of 10 alphanumeric characters."},"pan":{"type":"string","description":"Full card PAN."},"maskedPan":{"type":"string","description":"Masked card PAN."},"cvv2":{"type":"string","description":"Card CVV2 number."},"externalRef":{"type":"string","description":"Client reference for the newly created card."},"createdDate":{"type":"string","format":"date-time","description":"The creation date of the card","example":"2019-01-29T11:01:54.826+0000"},"maxLimit":{"type":"string","description":"Maximum Limit which can be set on this card and is the maximum lifetime spend the card can have","example":"4000.00"},"frequencyUsage":{"type":"string","description":"Card frequency usage","enum":["SINGLE_USE","MULTI_USE"],"example":"MULTI_USE"},"shareLink":{"type":"string","description":"Link that can be used by client to share secure details. Will only be returned when shareDetails method is RETURN in request body."}},"required":["createdDate","cvv2","externalRef","frequencyUsage","id","maxLimit","pan"]},"payment.BatchSummary":{"type":"object","properties":{"total":{"type":"integer","format":"int64","description":"Total count of payment requests in this batch"},"inprogress":{"type":"integer","format":"int64","description":"Count of payment requests in progress"},"invalid":{"type":"integer","format":"int64","description":"Count of invalid payment requests"},"errors":{"type":"integer","format":"int64","description":"Count of failed payment requests"},"cancelled":{"type":"integer","format":"int64","description":"Count of cancelled payment requests"},"completed":{"type":"integer","format":"int64","description":"Count of completed payments"},"info":{"type":"string","description":"Additional information or error message regarding this batch payment request"}}},"onboarding.ScreeningResultsRequest":{"type":"object","properties":{"adverseMedia":{"type":"array","items":{"type":"string"}},"peps":{"type":"array","items":{"type":"string"}},"sanctions":{"type":"array","items":{"type":"string"}}}},"account.ConsumerDataRequest":{"type":"object","properties":{"employment":{"type":"string"},"natureOfRelationship":{"type":"string"},"expectedTransactionalActivity":{"$ref":"#/components/schemas/account.ExpectedTransactionalActivityRequest"},"screeningResults":{"$ref":"#/components/schemas/account.ScreeningResultsRequest"},"sourceOfWealth":{"$ref":"#/components/schemas/account.SourceOfWealthRequest"}}},"directdebit.DirectDebitPageResponseCollection":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/directdebit.Collection"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0-based, i.e first page = 0, second page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"onboarding.CustomerComplianceDataResponse":{"type":"object","properties":{"typeDescription":{"type":"string"},"riskLevel":{"type":"string","enum":["LOW","MEDIUM","HIGH","UNDETERMINED"]},"vulnerabilityReasons":{"type":"array","items":{"type":"string","enum":["LIFE_EVENTS","HEALTH","RESILIENCE","CAPABILITY","FINANCIAL_DIFFICULTY"]}},"business":{"$ref":"#/components/schemas/onboarding.BusinessDataResponse"},"consumer":{"$ref":"#/components/schemas/onboarding.ConsumerDataResponse"}}},"card.PatchOperation":{"type":"object","discriminator":{"propertyName":"op","mapping":{"add":"#/components/schemas/card.Add","move":"#/components/schemas/card.Move","test":"#/components/schemas/card.Test","replace":"#/components/schemas/card.Replace","copy":"#/components/schemas/card.Copy","remove":"#/components/schemas/card.Remove"}},"properties":{"op":{"type":"string"},"path":{"type":"string","example":"/path/to/field"}},"required":["op","path"]},"cardsimulator.CreateCreditAuthorisationRequest":{"type":"object","description":"Details of the credit authorisation","properties":{"transactionAmount":{"type":"number"},"transactionCurrency":{"type":"string","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"fxRate":{"type":"number"},"mcc":{"type":"string"}},"required":["fxRate","mcc","transactionAmount","transactionCurrency"]},"channelmanager.CardResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card identifier. Maximum of 10 alphanumeric characters","example":"V000000001"},"holder":{"$ref":"#/components/schemas/channelmanager.CardHolder","description":"CardHolder"},"expiry":{"type":"string","description":"An ISO 8601 date with year & month components only","example":"2018-12"},"status":{"type":"string","description":"The current state of the card."},"currency":{"type":"string","description":"A 3 letter ISO 4217 code representing the card currency","example":"GBP"},"limit":{"type":"string","description":"Total card authorisation limit","example":"1000.00"},"maxLimit":{"type":"string","description":"Maximum limit which can be set on this card and is the maximum lifetime spend the card can have","example":"4000.00"},"spend":{"type":"string","description":"Current total of all authorisations on this card","example":"250.00"},"externalRef":{"type":"string","description":"Client reference for the newly created card. Maximum of 50 characters.","example":"TTQ_51211"},"maskedPan":{"type":"string","description":"Masked card PAN","example":"527095******3544"},"cardType":{"type":"string","description":"Card product type","example":"Business"},"cardScheme":{"type":"string","description":"Card scheme. MASTERCARD or VISA","example":"MASTERCARD"},"accountBid":{"type":"string","description":"Account identifier","example":"A020N8PD"},"productId":{"type":"string","description":"Product identifier","example":"O210003A"},"format":{"type":"string","description":"The format of the card.  PHYSICAL or VIRTUAL","enum":["PHYSICAL","VIRTUAL"],"example":"PHYSICAL"},"constraints":{"$ref":"#/components/schemas/channelmanager.CardConstraints","description":"CardConstraints"},"design":{"$ref":"#/components/schemas/channelmanager.ProductDesignDetail","description":"External reference for card design. Will only be returned for physical cards"},"printedName":{"type":"string","description":"Name printed on the card. Will only be returned for physical cards. Maximum of 20 alphanumeric characters (including full stop, hyphen, apostrophe, caret and space)"},"cancellationDate":{"type":"string","description":"Date card will be cancelled on","example":"2025-01-01"},"createdDate":{"type":"string","format":"date-time"},"threeDSecureStatus":{"type":"string","deprecated":true,"description":"The 3DS status of the card, based on the SMS one time password","enum":["NOT_ENROLLED","ENROLLED","UNENROLLED"],"example":"ENROLLED"},"authentication":{"$ref":"#/components/schemas/channelmanager.CardThreeDSecureAuthentication","description":"The 3DS authentication method statuses"},"shippingAddress":{"$ref":"#/components/schemas/channelmanager.AddressDetail","description":"Shipping address"},"customFields":{"type":"array","description":"Custom fields currently defined for card","items":{"$ref":"#/components/schemas/channelmanager.CardCustomFieldResponse"}},"authWindow":{"$ref":"#/components/schemas/channelmanager.AuthorisationWindow","description":"Authorisation window defined for card"},"channelManagerId":{"type":"string","description":"Channel Manager identifier","example":"M883412312"},"frequencyUsage":{"type":"string","description":"Enum that specifies the frequency usage of the card","enum":["SINGLE_USE","MULTI_USE"],"example":"SINGLE_USE"}}},"onboarding.SourceOfWealthResponse":{"type":"object","properties":{"standard":{"type":"string"},"pep":{"type":"string"}}},"directdebit.BulkCancelMandateRequest":{"type":"object","description":"List of the Direct Debit mandates to cancel","properties":{"accountId":{"type":"string","description":"The unique identifier for the account for which the mandates are to be cancelled.","minLength":1},"migrationType":{"type":"string","description":"The type of migration process that is being initiated.","enum":["SCHEDULE_AUDDIS_MIGRATION","TRANSFER_OF_SUN","OFFBOARDING"]},"auddisCancellationDate":{"type":"string","format":"date","description":"The date for the AUDDIS (Automated Direct Debit Instruction Service) cancellation."},"mandateIds":{"type":"array","description":"List of mandate ids to be cancelled.","items":{"type":"string"},"minItems":1}},"required":["accountId","mandateIds","migrationType"]},"cardsimulator.ReverseAuthorizationRequest":{"type":"object","description":"Partial reversal amount. Omit body for full reversal","properties":{"reversalAmount":{"type":"number","description":"Amount to reverse. If absent or equal to the open amount, a full reversal is performed. Must not exceed the open amount.","example":"3.00"}}},"card.OneTimeTokenResponse":{"type":"object","properties":{"token":{"type":"string","description":"The token to use by the client for retrieving card details. Where 'encrypted' is true, this will be a value that must be decrypted on the client device before being used in subsequent API calls","example":"eyJ0....zRyk"},"encrypted":{"type":"boolean","description":"Whether this token is encrypted"},"encryptedSymmetricKey":{"type":"string","description":"Base64 UTF-8 encoded Symmetric key used to encrypt token, encrypted with client's public key. Only provided if 'encrypted' is true."},"initialisationVector":{"type":"string","description":"Base64 UTF-8 encoded initialisation vector used with symmetric key for encrypting the token. Only provided if 'encrypted' is true."}},"required":["encrypted","token"]},"pispgateway.CreateStandingOrderInitiationRequest":{"type":"object","description":"Request object to Initiate Standing Order","properties":{"aspspId":{"type":"string","description":"Identifier for ASPSP being used for the standing order","example":"H100000001","minLength":1},"payment":{"$ref":"#/components/schemas/pispgateway.StandingOrderPayment","description":"The payment of the standing order"},"schedule":{"$ref":"#/components/schemas/pispgateway.StandingOrderSchedule","description":"The schedule of the standing order"},"context":{"$ref":"#/components/schemas/pispgateway.PaymentContext","description":"Payment context used to specify additional details for risk scoring"}},"required":["aspspId","context","payment","schedule"]},"customercompliance.CustomerIdentificationInformationRequest":{"type":"object","properties":{"customerIdentificationInformations":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.CustomerIdentificationInformation"}}}},"card.CardThreeDSecureAuthentication":{"type":"object","properties":{"otpSmsStatus":{"type":"string","description":"The SMS one time password authentication status","enum":["NOT_ENROLLED","ENROLLED","UNENROLLED"],"example":"ENROLLED"},"knowledgeBaseStatus":{"type":"string","description":"The knowledge based authentication (KBA) status","enum":["NOT_ENROLLED","ENROLLED","UNENROLLED"],"example":"ENROLLED"}}},"account.externalReference":{"type":"array","description":"A list of external references to filter","example":"\"externalReference[0].type\": \"WORD_MATCH\", \"externalReference[0].value\": \"Customer reference\"","items":{"$ref":"#/components/schemas/account.StringSearchCriteria"}},"payment.FxDetails":{"type":"object","properties":{"quoteId":{"type":"string","description":"Quote Id for foreign exchange trade"}},"required":["quoteId"]},"onboarding.AdditionalAssociateIdentifier":{"type":"object","properties":{"type":{"type":"string","description":"Type of additional personal identifier","enum":["BSN"]},"value":{"type":"string","description":"Personal identifier value","minLength":1}},"required":["type","value"]},"onboarding.ConsumerDuty":{"type":"object","properties":{"scope":{"type":"string","enum":["IN_SCOPE","NOT_IN_SCOPE"]},"numberOfEmployees":{"type":"integer","format":"int32"},"netAssets":{"type":"number"},"turnover":{"type":"number"}}},"directdebit.BulkCreateResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique id for this bulk request.","example":"R210000001"},"accountId":{"type":"string","description":"Unique id for account for this bulk request.","example":"A0000001"},"status":{"type":"string","description":"Status for this bulk request."},"migrationType":{"type":"string","description":"Migration type for this bulk request.","enum":["SCHEDULE_AUDDIS_MIGRATION","TRANSFER_OF_SUN","OFFBOARDING"]},"totalMandatesRequested":{"type":"integer","format":"int64","description":"Total mandates requested for this bulk request."},"auddisSubmissionDate":{"type":"string","format":"date","description":"auddis submission date for this bulk request."}},"required":["accountId","auddisSubmissionDate","id","migrationType","status","totalMandatesRequested"]},"card.AuthorisationWindowRequest":{"type":"object","properties":{"startDate":{"type":"string","example":"2025-01-01"},"endDate":{"type":"string","example":"2025-01-01"}}},"onboarding.BusinessDataResponse":{"type":"object","properties":{"natureOfRelationship":{"type":"string"},"expectedTransactionalActivity":{"$ref":"#/components/schemas/onboarding.ExpectedTransactionalActivityResponse"},"screeningResults":{"$ref":"#/components/schemas/onboarding.ScreeningResultsResponse"},"sourceOfWealth":{"$ref":"#/components/schemas/onboarding.SourceOfWealthResponse"}}},"account.CreateAccountIdentifier":{"type":"object","properties":{"type":{"type":"string","enum":["SCAN"]},"sortCode":{"type":"string","pattern":"^\\d{6}$"},"accountNumber":{"type":"string","pattern":"^\\d{8}$"}},"required":["accountNumber","sortCode","type"]},"card.ReportPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/card.ReportResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"card.BulkCardsOpsRequest":{"type":"object","properties":{"externalRef":{"type":"string"},"operations":{"type":"array","items":{"$ref":"#/components/schemas/card.BulkCardsOperation"},"minItems":1}},"required":["operations"]},"onboarding.BusinessDataRequest":{"type":"object","properties":{"natureOfRelationship":{"type":"string"},"expectedTransactionalActivity":{"$ref":"#/components/schemas/onboarding.ExpectedTransactionalActivityRequest"},"screeningResults":{"$ref":"#/components/schemas/onboarding.ScreeningResultsRequest"},"sourceOfWealth":{"$ref":"#/components/schemas/onboarding.SourceOfWealthRequest"}}},"pispgateway.VrpPaymentDetailsResponse":{"type":"object","properties":{"consentId":{"type":"string","description":"The unique identifier of the VRP consent initiation request at Modulr.","example":"E210000004"},"payment":{"$ref":"#/components/schemas/pispgateway.Payment","description":"Payment details for the VRP payment initiation request."},"status":{"type":"string","description":"The current status of the VRP payment.","enum":["SUBMITTED","ACCEPTEDWITHOUTPOSTING","ACCEPTEDSETTLEMENTINPROCESS","PENDING","REJECTED","ACCEPTEDCREDITSETTLEMENTCOMPLETED","ACCEPTEDSETTLEMENTCOMPLETED","RECEIVED","CANCELLED","BLOCKED","ACCEPTEDTECHNICALVALIDATION","ACCEPTEDCUSTOMERPROFILE","ACCEPTEDFUNDSCHECKED","ACCEPTEDWITHCHANGE","ACCEPTEDSETTLEMENTCOMPLETEDCREDITORACCOUNT","ACCEPTEDSETTLEMENTCOMPLETEDDEBITORACCOUNT","ER_GENERAL","ER_EXTSYS"]},"statusReasonCodes":{"type":"array","items":{"type":"string","description":"Specifies the status reason in a code form.","example":"ERIN","maxLength":4,"minLength":1}},"interactionType":{"type":"string","description":"PSU interaction type permitted under this consent. Must be one of: IN_SESSION (customer is present), OFF_SESSION (customer is not present).","enum":["IN_SESSION","OFF_SESSION"]}},"required":["consentId","payment","status"]},"payment.PaymentOutRequest":{"type":"object","description":"Details of Payment request","properties":{"sourceAccountId":{"type":"string","description":"Identifier for the sending Account."},"destination":{"$ref":"#/components/schemas/payment.Destination","description":"Destination of the Payment"},"currency":{"type":"string","description":"Currency of the account in ISO 4217 format. Default is GBP","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"amount":{"type":"number","description":"Amount of the payment in Major Current Units - '1' = 1.00 GBP","example":"100.00","maximum":2147483647,"minimum":0.01},"reference":{"type":"string","description":"Reference to be used for the Payment. This will appear on the Account statement/the recipient's bank account. Min 6 to max 18 characters that are not all the same (up to 140 characters for currencies other than GBP). Can contain alphanumeric, '-', '.', '&', '/' and space.","example":"Salary"},"externalReference":{"type":"string","description":"Your reference for this payment","example":"aReference_00001","maxLength":50,"minLength":0,"pattern":"[\\w-\\s]*"},"endToEndReference":{"type":"string","description":"Optional end to end reference. For international payments, Modulr payment ID will be used as end-to-end reference.","example":"aReference_00001"},"regulatoryReporting":{"$ref":"#/components/schemas/payment.RegulatoryReporting","description":"Regulatory reporting"},"paymentDate":{"type":"string","description":"The future date on which to make the payment. Date format 'yyyy-MM-dd'.\n\nNot applicable for international payments which will be submitted on date of submission or next working day, in line with cut-offs.","example":"2017-01-28"},"overseasPaymentDetail":{"$ref":"#/components/schemas/payment.POODetails","description":"Details relating to payment originated overseas.\n\nNot applicable for international payments - all international transactions must originate from the Modulr account creating the payment request."},"purposeOfPayment":{"type":"string","description":"A code from the UK Recommended Purpose Code list that indicates the type of Payment. This is optional for most payment types but recommended to be completed where possible; where it is required for certain purposes of CHAPS payment if not supplied a default value will be used","enum":["BKFE","BKIP","BKPP","CBLK","ACCT","CASH","COLL","CSDB","DEPT","INTC","INTP","LIMA","NETT","EXTD","OTCD","REPO","SBSC","SLEB","AGRT","AREN","BEXP","BOCE","COMC","CPYR","GDSV","GSCB","LICF","ROYA","SERV","SUBS","SUPP","TRAD","CHAR","COMT","ECPR","EPAY","CLPR","COMP","DBTC","HLRP","HLST","INPC","INPR","INSC","INSU","INTE","LBRI","LIFI","LOAN","LOAR","PENO","PPTI","RELG","TRFD","FORW","FXNT","BLDM","BNET","CDBL","CORT","CPKC","EDUC","FAND","FEES","GIFT","GOVT","INSM","IVPT","REBT","REFU","RENT","REOD","TCSC","CMDT","DERI","DIVD","FREX","HEDG","INVS","SAVG","SECU","TREA","FNET","FUTR","DNTS","HLTI","LTCF","MDCS","VIEW","SWFP","SWPP","SWRS","SWUF","ADCS","ALMY","BECH","BENE","BONU","COMM","HREC","PEFC","PENS","SALA","SSBE","LREB","LREV","ESTX","HSTX","INTX","PTXP","RDTX","TAXS","VATX","WHLD","TAXR","CBTV","ELEC","GASB","PHON","UBIL","WTER","GAMB","LOTT","PCOM","PDEP","PLDS","PLRF"]},"categoryOfPayment":{"type":"string","description":"A category code from the UK Recommended Purpose Code list that indicates the general category of the Payment. This is optional for all types of payment, and defaults to 'OTHR' on schemes that accept category","enum":["BONU","CASH","CBLK","CCRD","CORT","DCRD","DIVI","DVPM","FCOL","GP2P","GOVT","HEDG","INTC","INTE","LOAN","MP2P","OTHR","PENS","RRCT","SALA","SECU","SSBE","SUPP","TAXS","TRAD","TREA","VATX","WHLD"]},"permittedScheme":{"type":"string","description":"Attempt to process the payment using only the specified scheme","enum":["SEPA_CREDIT_TRANSFER"]},"nameCheck":{"$ref":"#/components/schemas/payment.NameCheck","description":"Reference to name check result for the destination account."},"fx":{"$ref":"#/components/schemas/payment.FxDetails","description":"Foreign exchange trade details"},"destinationId":{"type":"string","writeOnly":true},"destinationType":{"type":"string","enum":["BENEFICIARY","ACCOUNT","IBAN","SCAN","INTL","ANBRN","AN"],"writeOnly":true}},"required":["sourceAccountId"]},"account.Copy":{"allOf":[{"$ref":"#/components/schemas/account.PatchOperation"},{"type":"object","properties":{"from":{"type":"string","example":"/path/to/originating/field"}}}],"description":"Copy field","required":["from","op","path"]},"onboarding.KnowYourBusiness":{"type":"object","properties":{"tradingName":{"type":"string","description":"The trading name of the business"},"incorporationDate":{"type":"string","format":"date","description":"Incorporation Date of the business"},"businessActivities":{"type":"string","description":"The business activities of the business"},"onlinePresenceUrl":{"type":"string","description":"The online presence URL of the business"},"expectedMonthlyTransactions":{"type":"integer","format":"int64","description":"Expected Monthly Transactions of the business"}}},"card.CardCustomFieldKeyPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/card.CardCustomFieldKeyResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"card.AsyncTaskResponse":{"type":"object","properties":{"taskBid":{"type":"string","description":"ID of async task","example":"T110000003"},"resourceUrl":{"type":"string","description":"Url of available resource after task completion","example":"/cards/V110000022"},"resourceId":{"type":"string","description":"ID of resource after task completion. Will only be returned for COMPLETE tasks.","example":"V110000022"},"type":{"type":"string","description":"Type of async task"},"status":{"type":"string","description":"Status of the task"},"createdDate":{"type":"string","format":"date-time","description":"The creation date of the task","example":"2020-03-23T11:01:54.826+0000"},"errorReason":{"type":"string","description":"The error reason. Only populated if status is ERROR"}},"required":["createdDate","status","taskBid","type"]},"account.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"card.UpdateCardAuthenticationRequest":{"type":"object","description":"Authentication","properties":{"knowledgeBase":{"type":"array","description":"3DS Knowledge-Based Authentication (KBA) answers","items":{"$ref":"#/components/schemas/card.CardKnowledgeBasedAuthentication"}}},"required":["knowledgeBase"]},"directdebitoutbound.EnquiryMandatesResponse":{"type":"object","properties":{"accountId":{"type":"string","description":"Account Id"},"mandatesList":{"type":"array","description":"List of Mandates","items":{"$ref":"#/components/schemas/directdebitoutbound.EnquiryMandateResponse"}}},"required":["accountId","mandatesList"]},"card.AuthorisationConstraints":{"type":"object","description":"Authorisation constraints","properties":{"spend":{"type":"array","description":"Spending constraints","items":{"$ref":"#/components/schemas/card.SpendConstraintDetail"}}}},"paymentfileupload.FileCreatePaymentsResult":{"type":"object","description":"Payment creation result for an individual file in a multi-file request","properties":{"fileId":{"type":"string","description":"Unique ID of the uploaded file","example":"F1100001","minLength":1},"status":{"type":"string","description":"Status of the uploaded file","enum":["NEW","SUBMITTED","PROCESSING","INVALID","VALID","DUPLICATE","REJECTED","ERROR_RETRYABLE","ACCEPTED","PROCESSED","SENDING","PAYMENT_PROCESSING","SPLIT_FILE","PARTIALLY_ACCEPTED"],"example":"INVALID"},"fileName":{"type":"string","description":"File name of the uploaded file","example":"file1"},"batchPaymentId":{"type":"string","description":"Optional batch payment ID for successful files","example":"B1100001"},"reason":{"type":"string","description":"Reason, if any, for invalid status","example":"Issue sending Batch payments"}},"required":["fileId","status"]},"channelmanager.CardThreeDSecureAuthentication":{"type":"object","properties":{"otpSmsStatus":{"type":"string","description":"The SMS one time password authentication status","enum":["NOT_ENROLLED","ENROLLED","UNENROLLED"],"example":"ENROLLED"},"knowledgeBaseStatus":{"type":"string","description":"The knowledge based authentication (KBA) status","enum":["NOT_ENROLLED","ENROLLED","UNENROLLED"],"example":"ENROLLED"}}},"pispgateway.DeliveryAddress":{"type":"object","description":"Information that locates and identifies a specific address, as defined by postal services or in free format text, must be specified if paymentContextCode is ECOMMERCEGOODS","properties":{"addressLine1":{"type":"string","description":"First line of the address","maxLength":70,"minLength":0},"addressLine2":{"type":"string","description":"Second line of the address","maxLength":70,"minLength":0},"postTown":{"type":"string","description":"The post town","maxLength":35,"minLength":0},"postCode":{"type":"string","description":"The postcode","maxLength":16,"minLength":0},"country":{"type":"string","description":"The country","minLength":1}},"required":["addressLine1","country","postCode","postTown"]},"channelmanager.CardCustomFieldRequest":{"type":"object","properties":{"key":{"type":"string","description":"Custom field key"},"value":{"type":"string","description":"Custom field value"}},"required":["key","value"]},"onboarding.TaxIdentifier":{"type":"object","properties":{"country":{"type":"string","description":"Country code (ISO Alpha-2) where the tax identifier was issued","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"type":{"type":"string","description":"Tax identifier type","enum":["NIF","CIF","TIN","BSN"]},"value":{"type":"string","description":"Tax identifier value"}}},"paymentfileupload.FileUploadStatusResponse":{"type":"object","description":"File upload Status Response","properties":{"status":{"type":"string","description":"Status of the uploaded file","enum":["NEW","SUBMITTED","PROCESSING","INVALID","VALID","DUPLICATE","REJECTED","ERROR_RETRYABLE","ACCEPTED","PROCESSED","SENDING","PAYMENT_PROCESSING","SPLIT_FILE","PARTIALLY_ACCEPTED"],"example":"INVALID"},"fileName":{"type":"string","description":"File name of the uploaded file","example":"file1"},"numTransactions":{"type":"integer","format":"int32","deprecated":true,"description":"Total number of transactions within file","example":1000},"numberOfTransactions":{"type":"integer","format":"int32","description":"Total number of transactions within file","example":1000},"totalAmount":{"type":"number","description":"Sum of all transaction's amount within file","example":"1539.81"},"errors":{"type":"string","description":"If invalid holds the validation errors","example":["Failed parsing"]},"validationResults":{"type":"string","description":"If invalid, holds the validation results","example":[{"type":"HEADER","lineNumber":4,"errors":[{"type":"INVALID_CURRENCY_CODE","field":"currencyCode","invalidValue":"01"}]}]}},"required":["status"]},"channelmanager.CardActivityResponse":{"type":"object","properties":{"id":{"type":"string","description":"The card activity identifier. Maximum of 10 alphanumeric characters","example":"X000000001"},"orderId":{"type":"string","description":"Order identifier which links together related authorisations, reversals & settlements. Maximum of 10 alphanumeric characters","example":"1234"},"cardId":{"type":"string","description":"Card identifier. Maximum of 10 alphanumeric characters","example":"V000000001"},"type":{"type":"string","description":"Type of card activity","enum":["AUTHORISATION","REVERSAL","SETTLEMENT","REFUND"]},"status":{"type":"string","description":"Status of card activity. Only applies to activities of type AUTHORISATION","enum":["DECLINED","APPROVED","SETTLED","EXPIRED"]},"reason":{"type":"string","description":"The reason why this activity was declined. Only applies to activities with status DECLINED","example":"Account has insufficient funds"},"verifiedBy3DS":{"type":"boolean","description":"Whether the activity was 3DS enabled"},"createdDate":{"type":"string","format":"date-time","description":"The creation date of the card activity","example":"2019-01-29T11:22:00+0000"},"transactionAmount":{"type":"number","description":"The card activity transaction amount","example":"123.45"},"transactionCurrency":{"type":"string","description":"The 3 letter ISO 4217 card activity transaction currency","example":"EUR"},"billingAmount":{"type":"number","description":"The card activity billing amount","example":"678.91"},"billingCurrency":{"type":"string","description":"The 3 letter ISO 4217 card activity billing currency","example":"GBP"},"fxRate":{"type":"number","description":"The FX rate applied to any conversion between transaction & billing amount. Rounded to 6 decimal places and zero padded","example":"1.123456"},"mcc":{"type":"string","description":"The Merchant Category Code (MCC) for the card activity. Follows ISO-18245 format","example":"5182"},"merchantName":{"type":"string","description":"The merchant name","example":"Loudons Cafe"},"merchantId":{"type":"string","description":"The merchant ID","example":"123456789012345"},"merchantCountry":{"type":"string","description":"The 3 letter ISO 3166 merchant country code","example":"GBR"},"acquirerReferenceNumber":{"type":"string","description":"The Acquirer Reference Number (ARN)","example":"123451234512345"},"authorisationInfo":{"$ref":"#/components/schemas/channelmanager.AuthInfo","description":"Authorisation information of the activity"},"cardTokenId":{"type":"string","description":"The card token associated with this activity, if a tokenised card was used."},"cardTokenDeviceId":{"type":"string","description":"The bound card token device associated with this activity, if a tokenised card was used."}},"required":["billingAmount","billingCurrency","cardId","createdDate","fxRate","id","mcc","orderId","transactionAmount","transactionCurrency","type"]},"directdebit.BulkCreateMandateRequest":{"type":"object","description":"List of Details of the Direct Debit mandates.","properties":{"accountId":{"type":"string","description":"The unique identifier for the account for which the mandates are to be created.","minLength":1},"migrationType":{"type":"string","description":"The type of migration process that is being initiated.","enum":["SCHEDULE_AUDDIS_MIGRATION","TRANSFER_OF_SUN","OFFBOARDING"]},"auddisSubmissionDate":{"type":"string","format":"date","description":"The scheduled date for the AUDDIS (Automated Direct Debit Instruction Service) submission. This is the date when the mandates will be submitted to the AUDDIS system for processing."},"createMandateRequests":{"type":"array","description":"The number of mandate creation requests. Each item in the array represents a request to create an individual mandate with its own set of parameters.","items":{"$ref":"#/components/schemas/directdebit.CreateMandateRequest"},"minItems":1}},"required":["accountId","createMandateRequests","migrationType"]},"pispgateway.PeriodicLimit":{"type":"object","description":"Maximum amount of all payments that can be initiated using this consent in a given period. If the periodAlignment is “Calendar”, the limit is pro-rated in the first period to the remaining number of days.","properties":{"currency":{"type":"string","description":"Currency of the maximum amount. Must be specified in ISO 4217 format."},"amount":{"type":"number","description":"The maximum amount of all payments initiated using this consent in the specified period. At least one periodic limit is required - '1' = 1.00 GBP","example":"100.00"},"periodAlignment":{"type":"string","description":"Specifies whether the period starts on the date of consent creation or lines up with a calendar."},"periodType":{"type":"string","description":"Period type. Must be one of “DAY”,”WEEK”,”FORTNIGHT”,”MONTH”,”HALF_YEAR”,”YEAR”."}},"required":["currency","periodAlignment","periodType"]},"customercompliance.TaxIdentifiersRequest":{"type":"object","properties":{"taxIdentifiers":{"type":"array","items":{"$ref":"#/components/schemas/customercompliance.TaxIdentifier"}}}},"customercompliance.BusinessAddressResponse":{"type":"object","properties":{"id":{"type":"string","description":"Business address ID"},"type":{"type":"string","description":"Business address type","enum":["REGISTERED","TRADING"]},"address":{"$ref":"#/components/schemas/customercompliance.AddressRequest","description":"Business address"}}},"account.customerStatuses":{"type":"array","items":{"type":"string","default":"ACTIVE","description":"Customer statuses","enum":["ACTIVE","CLOSED","BLOCKED"]}},"account.Remove":{"allOf":[{"$ref":"#/components/schemas/account.PatchOperation"}],"description":"Remove field","required":["op","path"]},"channelmanager.ReportPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/channelmanager.ReportResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"account.Customer":{"type":"object","description":"A Customer is a single legal entity that can have 1 or more accounts","properties":{"id":{"type":"string","description":"Unique identifier for a Customer. Begins with 'C'","example":"C00000001"},"name":{"type":"string","description":"Customer's company name - must be unique across the Modulr platform."},"brandNames":{"type":"array","description":"The customers brand name(s)","items":{"$ref":"#/components/schemas/account.BrandNameResponse"}},"type":{"type":"string","description":"Type of the customer, 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"},"status":{"type":"string","description":"Status of the Customer. Customers must be 'Active' for Accounts to be created for them.","enum":["ACTIVE","CLOSED","BLOCKED"]},"verificationStatus":{"type":"string","description":"How the identity of the Customer has been verified. Can be:\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"},"companyRegNumber":{"type":"string","description":"The company registration / incorporation number of the company. Only applicable for companies registered with Companies House"},"expectedMonthlySpend":{"type":"integer","format":"int32","description":"Indication of the monthly spend of the customer."},"registeredAddress":{"$ref":"#/components/schemas/account.AddressResponse","description":"The address of the company's registered office."},"tradingAddress":{"$ref":"#/components/schemas/account.AddressResponse","description":"The address of the company's day-to-day trading activities."},"partnerId":{"type":"string","description":"The owning partner identifier"},"associates":{"type":"array","description":"Array of associate objects that link to the Customer. For example, this could contain the details of the company directors for a Limited company, or or the partners for a partnership.","items":{"$ref":"#/components/schemas/account.AssociateResponse"}},"industryCode":{"type":"string"},"tcsVersion":{"type":"integer","format":"int32","description":"Version of the Modulr Account Terms and Conditions the Customer has agreed to."},"documentInfo":{"type":"array","description":"Array of document objects that relate to the Customer being created. Examples of Documents could be proof of a Company Director's identity or address, Articles of Association or a Partnership Agreement.","items":{"$ref":"#/components/schemas/account.DocumentInfo"}},"externalReference":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Datetime when the customer was created.Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000"},"delegate":{"$ref":"#/components/schemas/account.DelegateResponse","description":"Details of this Customer's linked Delegate"},"legalEntity":{"type":"string","description":"Legal entity of the customer","enum":["GB","NL","IE"]},"customerTrust":{"$ref":"#/components/schemas/account.CustomerTrustResponse","description":"Trust nature for customers of type trust. Mandatory for type Trust, not to be set for non-trust customers."},"taxProfile":{"$ref":"#/components/schemas/account.CustomerTaxProfileResponse","description":"Tax profile for customers of type SOLETRADER. Optional for type SOLETRADER, not to be set for non-SOLETRADER customers."},"complianceData":{"$ref":"#/components/schemas/account.CustomerComplianceDataResponse","description":"Required for customers of type PREQUALIFIED. Not allowed for all other customer types."},"complianceSector":{"type":"string","example":"Agency Lite Consumer"},"generateStatements":{"type":"boolean","description":"True if the customer is configured to generate statements"}}},"payment.PaymentPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/payment.PaymentResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0-based, i.e first page = 0, second page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"card.Copy":{"allOf":[{"$ref":"#/components/schemas/card.PatchOperation"},{"type":"object","properties":{"from":{"type":"string","example":"/path/to/originating/field"}}}],"description":"Copy field","required":["from","op","path"]},"card.ShareSecureCardDetailsPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/card.ShareSecureCardDetailsResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"directdebitoutbound.EnquiryMandateResponse":{"type":"object","properties":{"mandateId":{"type":"string","description":"Mandate Id"},"merchantNumber":{"type":"string","description":"Merchant Number"},"merchantName":{"type":"string","description":"Merchant Name"},"merchantAccountNumber":{"type":"string","description":"Merchant Account Number"},"merchantSortCode":{"type":"string","description":"Merchant Sort Code"},"mandateStatus":{"type":"string","description":"Status"},"auddisIndicator":{"type":"string","description":"AUDDIS Flag (AUDDIS / Non-AUDDIS)","enum":["A","N","T"]},"setupDate":{"type":"string","description":"Setup date"},"mandateReference":{"type":"string","description":"Mandate Reference"}},"required":["auddisIndicator","mandateId","mandateReference","mandateStatus","merchantAccountNumber","merchantName","merchantNumber","merchantSortCode","setupDate"]},"customercompliance.ContactDetailsRequest":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Email address","minLength":1},"phone":{"type":"string","description":"Phone number","minLength":1}},"required":["email","phone"]},"card.Constraints":{"type":"object","properties":{"authorisation":{"$ref":"#/components/schemas/card.AuthorisationConstraints","description":"Authorisation constraints"}}},"onboarding.AssociateComplianceDataRequest":{"type":"object","properties":{"relationship":{"type":"string","maxLength":50,"minLength":0}},"required":["relationship"]},"card.ShareSecureCardDetailsTokenActivityPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/card.ShareSecureCardDetailsActivity"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"onboarding.ApplicationSdkKeyResponse":{"type":"object","properties":{"token":{"type":"string"},"hmac":{"type":"string"},"expires":{"type":"string","format":"date-time"}}},"onboarding.EmploymentServices":{"type":"object","properties":{"temporaryStaff":{"type":"boolean"},"directEmployeesOnly":{"type":"boolean"}},"required":["directEmployeesOnly","temporaryStaff"]},"document.DocumentResponse":{"type":"object","properties":{"path":{"type":"string"},"fileName":{"type":"string"}}},"payment.status":{"type":"array","items":{"type":"string","description":"Payment status, multiple statuses can be specified by repeating the parameter","enum":["SUBMITTED","SCREENING_REQ","VALIDATED","PENDING_FOR_DATE","PENDING_FOR_FUNDS","EXT_PROC","PROCESSED","RECONCILED","ER_INVALID","ER_EXTCONN","ER_EXTSYS","ER_EXPIRED","ER_GENERAL","ER_BATCH","EXT_SENT","UNALLOCATED","HELD","RETURNED","CANCELLED","REPROCESSING","VOID","CLEARING","HELD_IN_SUSPENSE"]}},"card.BulkCardsOperation":{"type":"object","properties":{"id":{"type":"string"},"operationType":{"type":"string","enum":["CREATE","UPDATE","PATCH","CANCEL"]},"payload":{},"cardId":{"type":"string"},"accountId":{"type":"string"}},"required":["operationType","payload"]},"rule.RulePageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/rule.RuleResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0-based, i.e first page = 0, second page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"account.ScreeningResultsRequest":{"type":"object","properties":{"adverseMedia":{"type":"array","items":{"type":"string"}},"peps":{"type":"array","items":{"type":"string"}},"sanctions":{"type":"array","items":{"type":"string"}}}},"notification.NotificationResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique Identifier for the notification."},"customerId":{"type":"string","description":"Unique Identifier for the customer of this notification."},"type":{"type":"string","description":"Type of notification","enum":["PAYIN","PAYOUT","BALANCE_LOW","BALANCE_HIGH","BALANCE","DDMANDATE","CUSTVSTAT","ACCOUNT_STATEMENT","PENDING_PAYMENTS","DD_INCOMING_DEBIT","DD_FAILED_CLAIM","DD_FUNDS_RETURNED","CARD_AUTH","CARD_AUTH_OFFLINE","CARD_CREATION","UPCOMING_CREDIT","UPCOMING_COLLECTION_CREDIT","UPCOMING_COLLECTION_DEBIT","CARD_STATUS_UPDATE","CARD_TOKEN_PROVISIONING","PAYMENT_COMPLIANCE_STATUS","DD_COLLECTION_STATUS","ACCOUNT_SWITCH_UPDATE","PAYMENT_FILE_UPLOAD","ACCOUNT_STATUS_CHANGE","PAYMENT_APPROVAL_STATUS_CHANGE","CUSTOMER_BATCH_PAYMENT_APPROVAL_STATUS_CHANGE","CARD_BULK_OPS_COMPLETED","CUSTOMER_STATUS","CREDIT_AUTH","DD_INDEMNITY_CLAIM_STATUS","APPLICATION_STATUS_CHANGE","CUSTOMER_CREATED"]},"channel":{"type":"string","description":"Channel used to send the notification.","enum":["EMAIL","WEBHOOK"]},"status":{"type":"string","description":"Status of notification.","enum":["ACTIVE","INACTIVE"]},"destinations":{"type":"array","description":"A list of emails or url(webhook) used to send the notification. For 'EMAIL' channel this can be a list of comma separated email addresses. For 'WEBHOOK' channel this will be a single URL.","items":{"type":"string"}},"config":{"$ref":"#/components/schemas/notification.NotificationConfig","description":"Configuration information for this Notification entity."}},"required":["channel","config","customerId","destinations","id","status","type"]},"directdebit.BulkCancelMandateResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique id for this bulk request.","example":"R210000001"},"accountId":{"type":"string","description":"Unique id for account for this bulk request.","example":"A0000001"},"status":{"type":"string","description":"Status for this bulk request."},"migrationType":{"type":"string","description":"Migration type for this bulk request.","enum":["SCHEDULE_AUDDIS_MIGRATION","TRANSFER_OF_SUN","OFFBOARDING"]},"totalMandatesRequested":{"type":"integer","format":"int64","description":"Total mandates requested for this bulk request."},"auddisCancellationDate":{"type":"string","format":"date","description":"auddis cancellation date for this bulk request."}},"required":["accountId","auddisCancellationDate","id","migrationType","status","totalMandatesRequested"]},"card.ReportResponse":{"type":"object","properties":{"id":{"type":"string"},"reportSubjectId":{"type":"string"},"reportDate":{"type":"string","format":"date"},"reportType":{"type":"string","enum":["DAILY_CARD_ACTIVITY","MONTHLY_CARD_ACTIVITY","DAILY_ACCOUNT_FUNDING","MONTHLY_ACCOUNT_FUNDING","DAILY_AUTH_WINDOW","DAILY_CARD_MANAGEMENT"]}}},"payment.RegulatoryAuthority":{"type":"object","properties":{"authorityName":{"type":"string","description":"Authority name. Maximum of 70 characters.","example":"Financial Conduct Authority","maxLength":70,"minLength":0},"authorityCountry":{"type":"string","description":"ISO 3166 country code of the ultimate payers address","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"],"example":"GB"}}},"account.Move":{"allOf":[{"$ref":"#/components/schemas/account.PatchOperation"},{"type":"object","properties":{"from":{"type":"string","example":"/path/to/originating/field"}}}],"description":"Move field","required":["from","op","path"]},"directdebit.id":{"type":"array","description":"Id(s) of Mandate(s) to fetch.","items":{"type":"string","description":"Id(s) of Mandate(s) to fetch."}},"verificationofpayee.OutboundVopResponse":{"type":"object","description":"Verify Payee Response","properties":{"id":{"type":"string","description":"Unique id of verify payee request.","example":"PAV0000001"},"result":{"$ref":"#/components/schemas/verificationofpayee.OutboundVopResponseResult","description":"The result of verify payee."}},"required":["id","result"]},"notification.UpdateNotificationRequest":{"type":"object","properties":{"status":{"type":"string","description":"Status of the notification.","enum":["ACTIVE","INACTIVE"]},"destinations":{"type":"array","description":"The list of emails or url(webhook) used for sending the notification. For 'EMAIL' channel this can be a list of comma separated email addresses. For 'WEBHOOK' channel this should be a single URL.","items":{"type":"string"},"minItems":1},"config":{"$ref":"#/components/schemas/notification.NotificationConfig","description":"Configuration information for this Notification entity."}},"required":["config","destinations","status"]},"directdebitoutbound.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"confirmationofpayee.JsonOutboundCopRequest":{"type":"object","description":"Details of Account Name Check Request","properties":{"paymentAccountId":{"type":"string","description":"The identifier of the account that a subsequent payment will be initiated from.","example":"A123AAA4"},"sortCode":{"type":"string","description":"The sort code of the account.","example":"000000","pattern":"^[0-9]{6}$"},"accountNumber":{"type":"string","description":"The account number.","example":"12345678","pattern":"^[0-9]{8}$"},"secondaryAccountId":{"type":"string","description":"Additional information used in conjunction with the Sort Code and Account Number to identify the account (such as a Building Society roll number).","example":"A-1234567890","maxLength":140,"minLength":1,"pattern":"^.{0}$|^\u0000$|^([^\u0000])+$"},"accountType":{"type":"string","description":"The type of account, either a personal or business account.","enum":["PERSONAL","BUSINESS"],"example":"PERSONAL"},"name":{"type":"string","description":"The name to match the account name against.","example":"Joe Bloggs","maxLength":140,"minLength":1}},"required":["accountNumber","accountType","name","paymentAccountId","sortCode"]},"onboarding.AddressRequest":{"type":"object","properties":{"addressLine1":{"type":"string","maxLength":50,"minLength":0},"addressLine2":{"type":"string","maxLength":50,"minLength":0},"postTown":{"type":"string","maxLength":50,"minLength":0},"postCode":{"type":"string","maxLength":10},"country":{"type":"string","description":"Mandatory for international payments."},"countrySubDivision":{"type":"string","maxLength":35,"minLength":0}},"required":["addressLine1","postTown"]},"customercompliance.PersonalInformation":{"type":"object","properties":{"sex":{"type":"string","description":"Biological sex","enum":["MALE","FEMALE"]},"cityOfBirth":{"type":"string","description":"City of birth"},"countryOfBirth":{"type":"string","description":"Country of birth (ISO Alpha-2 code)","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"nationalities":{"type":"array","description":"List of associated nationalities (ISO Alpha-2 codes)","items":{"type":"string","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]}}}},"account.CreateBeneficiaryRequest":{"type":"object","properties":{"externalReference":{"type":"string","description":"External Reference can only have alphanumeric characters plus underscore, hyphen and space up to 50 characters long","maxLength":50,"minLength":0,"pattern":"[\\w \\-]*"},"name":{"type":"string","maxLength":100,"minLength":0,"pattern":"^([^\\p{L}0-9]*?[\\p{L}0-9]){1,}['\\.\\-\\/&\\s]*"},"birthdate":{"type":"string","format":"date","description":"The destination beneficiary's date of birth. Date in yyyy-MM-dd format"},"emailAddress":{"type":"string","format":"email","description":"The destination beneficiary's email address"},"phoneNumber":{"type":"string","description":"The destination beneficiary's phone number, will be formatted into international number pattern"},"destinationIdentifier":{"$ref":"#/components/schemas/account.IdentifierRequest"},"defaultReference":{"type":"string","minLength":1},"idToReplace":{"type":"string"},"address":{"$ref":"#/components/schemas/account.AddressRequest","description":"Optional address."},"qualifier":{"type":"string","description":"Optional qualifier. Only to be supplied if multiple beneficiaries with same destination need to be supplied","maxLength":100,"minLength":0}},"required":["defaultReference","destinationIdentifier","name"]},"channelmanager.Test":{"allOf":[{"$ref":"#/components/schemas/channelmanager.PatchOperation"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/channelmanager.JsonNode"}}}],"description":"Test field","required":["op","path","value"]},"account.IdentifierRequest":{"type":"object","properties":{"type":{"type":"string"},"accountNumber":{"type":"string","example":"12345678"},"accountType":{"type":"string","description":"Bank account type like PERSONAL/BUSINESS","enum":["PERSONAL","BUSINESS"]},"sortCode":{"type":"string","example":"000000","pattern":"^\\d{6}"},"iban":{"type":"string","example":"GB20MODR00000000000001","pattern":"[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}([a-zA-Z0-9]?){0,26}"},"bic":{"type":"string","example":"MODRGB21","pattern":"([a-zA-Z]{6,6}[a-zA-Z2-9][a-nA-Np-zP-Z0-9]([a-zA-Z0-9]{3})?)"},"currency":{"type":"string","example":"GBP","pattern":"[a-zA-Z]{3}"},"countrySpecificDetails":{"$ref":"#/components/schemas/account.IdentifierCountrySpecificDetailsRequest","example":{"branchCode":"123456789"}}}},"cardsimulator.CardAuthorisationRequest":{"type":"object","description":"Details of the authorisation to create","properties":{"transactionAmount":{"type":"number","description":"The transaction amount","example":"5.45"},"transactionCurrency":{"type":"string","description":"The transaction currency. Defaults to the card's billing currency","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"GBP"},"fxRate":{"type":"number","description":"The foreign exchange rate to use, when transaction currency differs from billing currency. Defaults to 1.0","example":"0.8"},"mcc":{"type":"string","description":"Merchant Category Code","example":"5812"}},"required":["mcc","transactionAmount"]},"payment.Destination":{"type":"object","properties":{"type":{"type":"string","description":"Indicates the type of destination. IBAN type is required for international payments.","enum":["BENEFICIARY","ACCOUNT","IBAN","SCAN","INTL","ANBRN","AN"],"example":"SCAN"},"id":{"type":"string","description":"Identifier for the Payment destination if using ACCOUNT or BENEFICIARY type. Can be either: a) Beneficiary id for an external Payment, b) Account id for a transfer to another Account"},"iban":{"type":"string","description":"International Bank Account Number (IBAN). To be used as the destination identifier when sending ‘IBAN’ type payments","example":"GB20MODR00000000000001","pattern":"^[a-zA-Z]{2}[0-9]{2}([a-zA-Z0-9]){11,30}$"},"accountNumber":{"type":"string","description":"Account Number of destination account if using SCAN type.","example":"12345678"},"sortCode":{"type":"string","description":"Sort Code of destination account if using SCAN type.","example":"000000","pattern":"^[0-9]{6}$"},"name":{"type":"string","description":"Name to use if a new beneficiary is created, and for using as the payee name if SCAN or IBAN types are specified for the destination","example":"Test","maxLength":100,"minLength":0},"address":{"$ref":"#/components/schemas/payment.AddressRequest","description":"Optional address. Mandatory for international payments."},"birthdate":{"type":"string","format":"date","description":"The destination beneficiary's date of birth. Format: yyyy-MM-dd","example":"2000-01-01"},"emailAddress":{"type":"string","description":"The destination beneficiary's email address","pattern":"[^\\s@]+@[^\\s@]+\\.[^\\s@]+"},"phoneNumber":{"type":"string","description":"The destination beneficiary's phone number"},"bic":{"type":"string","description":"The destination beneficiary's SWIFT BIC (Bank Identifier Code). Only to be used for international payments."},"countrySpecificDetails":{"$ref":"#/components/schemas/payment.DestinationCountrySpecificDetails","description":"Further details required, depending on the destination's country"},"legalEntityIdentifier":{"type":"string","description":"The destination beneficiary's Legal entity Identifier"}},"required":["type"]},"channelmanager.CreateWebhookNotificationRequest":{"type":"object","properties":{"type":{"type":"string","description":"Webhook type"},"destination":{"type":"string","description":"URL destination","example":"https://example.com/webhook","maxLength":250,"minLength":12,"pattern":"^(?i)(https://)([\\w\\.-]+)\\.([a-z\\.]{2,10})([\\w\\./-])*"},"retry":{"type":"boolean","description":"Flag indicating whether failed webhooks should be retried"},"secret":{"type":"string","description":"Webhook secret, must be 32 chars","maxLength":32,"minLength":32},"hmacAlgorithm":{"type":"string","description":"Signing algorithm that is used in Webhook HMAC calculation","enum":["hmac-sha1","hmac-sha256","hmac-sha384","hmac-sha512"]}},"required":["destination","hmacAlgorithm","retry","secret","type"]},"card.CardActivityResponse":{"type":"object","properties":{"id":{"type":"string","description":"The card activity identifier. Maximum of 10 alphanumeric characters","example":"X000000001"},"orderId":{"type":"string","description":"Order identifier which links together related authorisations, reversals & settlements. Maximum of 10 alphanumeric characters","example":"1234"},"cardId":{"type":"string","description":"Card identifier. Maximum of 10 alphanumeric characters","example":"V000000001"},"type":{"type":"string","description":"Type of card activity","enum":["AUTHORISATION","REVERSAL","SETTLEMENT","REFUND"]},"status":{"type":"string","description":"Status of card activity. Only applies to activities of type AUTHORISATION","enum":["DECLINED","APPROVED","SETTLED","EXPIRED"]},"reason":{"type":"string","description":"The reason why this activity was declined. Only applies to activities with status DECLINED","example":"Account has insufficient funds"},"verifiedBy3DS":{"type":"boolean","description":"Whether the activity was 3DS enabled"},"createdDate":{"type":"string","format":"date-time","description":"The creation date of the card activity","example":"2019-01-29T11:22:00+0000"},"transactionAmount":{"type":"number","description":"The card activity transaction amount","example":"123.45"},"transactionCurrency":{"type":"string","description":"The 3 letter ISO 4217 card activity transaction currency","example":"EUR"},"billingAmount":{"type":"number","description":"The card activity billing amount","example":"678.91"},"billingCurrency":{"type":"string","description":"The 3 letter ISO 4217 card activity billing currency","example":"GBP"},"fxRate":{"type":"number","description":"The FX rate applied to any conversion between transaction & billing amount. Rounded to 6 decimal places and zero padded","example":"1.123456"},"mcc":{"type":"string","description":"The Merchant Category Code (MCC) for the card activity. Follows ISO-18245 format","example":"5182"},"merchantName":{"type":"string","description":"The merchant name","example":"Loudons Cafe"},"merchantId":{"type":"string","description":"The merchant ID","example":"123456789012345"},"merchantCountry":{"type":"string","description":"The 3 letter ISO 3166 merchant country code","example":"GBR"},"acquirerReferenceNumber":{"type":"string","description":"The Acquirer Reference Number (ARN)","example":"123451234512345"},"authorisationInfo":{"$ref":"#/components/schemas/card.AuthInfo","description":"Authorisation information of the activity"},"cardTokenId":{"type":"string","description":"The card token associated with this activity, if a tokenised card was used."},"cardTokenDeviceId":{"type":"string","description":"The bound card token device associated with this activity, if a tokenised card was used."}},"required":["billingAmount","billingCurrency","cardId","createdDate","fxRate","id","mcc","orderId","transactionAmount","transactionCurrency","type"]},"account.DelegateResponse":{"type":"object","description":"Delegate","properties":{"id":{"type":"string","description":"Unique reference for the Delegate.","example":"D0000001"},"name":{"type":"string","description":"Name for the Delegate"},"address":{"$ref":"#/components/schemas/account.AddressResponse","description":"Address of the Delegate"},"roleId":{"type":"string","description":"The id of the Role assigned to the delegate","example":"R02002M5"},"externalReference":{"type":"string","description":"External system reference for the Delegate"},"partner":{"type":"string","description":"Partner Bid.","example":"R0000001"},"status":{"type":"string","description":"Status of the Delegate."},"created":{"type":"string","format":"date-time","description":"Datetime the Delegate was created.Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000"},"updated":{"type":"string","format":"date-time","description":"Datetime the Delegate was last updated.Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000"}}},"card.CardCustomFieldRequest":{"type":"object","properties":{"key":{"type":"string","description":"Custom field key"},"value":{"type":"string","description":"Custom field value"}},"required":["key","value"]},"pispgateway.CreateVrpConsentCreationRequest":{"type":"object","description":"Request object to Initiate VRP Consent Creation","properties":{"aspspId":{"type":"string","description":"Identifier of the payer’s ASPSP where the consent will be created. The ASPSP must have the \"SWEEPING\" or \"COMMERCIAL\" capability enabled (which can be checked using our API).","example":"H100000001"},"destination":{"$ref":"#/components/schemas/pispgateway.Destination","description":"Destination account details that will receive variable recurring payments initiated using this consent."},"paymentConstraints":{"$ref":"#/components/schemas/pispgateway.PaymentConstraints","description":"Limits that will apply to payments initiated using this consent."},"validFromDate":{"type":"string","format":"date-time","description":"Start date time from which payments can be initiated using this consent. Must be specified using YYYY-MM-DDTHH:mm:ssZ format.","example":"2022-01-31T20:16:01.90Z"},"validToDate":{"type":"string","format":"date-time","description":"End date time after which payments cannot be initiated using this consent. Must be specified using YYYY-MM-DDTHH:mm:ssZ format.","example":"2022-07-31T20:16:01.90Z"},"type":{"type":"string","description":"Type of VRP consent that will be created.","enum":["SWEEPING","CVRP1"]},"reference":{"type":"string","description":"Reference to be used for the Consent. This will appear on the Account statement/the recipient's bank account. Min 6 to max 18 characters. Can contain alphanumeric, '-', '.', '&', '/' and space.","example":"Invoice ABC123"},"interactionTypes":{"type":"array","description":"List of PSU interaction types permitted under this consent. Mandatory for CVRP consent type. Must be one or both of IN_SESSION (customer is present), OFF_SESSION (customer is not present)","items":{"type":"string","enum":["IN_SESSION","OFF_SESSION"]}},"ultimateCreditor":{"$ref":"#/components/schemas/pispgateway.UltimateParty","description":"The ultimate beneficiary of the payment, party to which an amount of money is due. To be provided if different from the immediate creditor."},"ultimateDebtor":{"$ref":"#/components/schemas/pispgateway.UltimateParty","description":"The ultimate payer, party that owes an amount of money to the (ultimate) creditor. To be provided if different from the account holder."},"risk":{"$ref":"#/components/schemas/pispgateway.OBRisk","description":"It is used to specify additional details for risk scoring for Payments."}},"required":["aspspId","destination","paymentConstraints","reference","type"]},"card.BulkCreateCustomFieldKeysRequest":{"type":"object","description":"Bulk create custom field keys request","properties":{"customFields":{"type":"array","description":"Custom fields","items":{"$ref":"#/components/schemas/card.CustomFields"},"maxItems":20,"minItems":1}},"required":["customFields"]},"customercompliance.TaxIdentifier":{"type":"object","properties":{"country":{"type":"string","description":"Country code (ISO Alpha-2) where the tax identifier was issued","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"type":{"type":"string","description":"Tax identifier type","enum":["NIF","CIF","TIN","BSN"]},"value":{"type":"string","description":"Tax identifier value"}}},"pispgateway.UltimateParty":{"type":"object","properties":{"name":{"type":"string","description":"Name by which a party is known and which is usually used to identify that party.","maxLength":140,"minLength":1},"identification":{"type":"string","description":"Identification assigned by an institution.","maxLength":256,"minLength":1},"lei":{"type":"string","description":"Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).","maxLength":20,"minLength":1},"postalAddress":{"$ref":"#/components/schemas/pispgateway.PostalAddress","description":"Information that locates and identifies a specific address, as defined by postal services."}}},"notification.NotificationConfig":{"type":"object","properties":{"threshold":{"type":"number","description":"Amount threshold which triggers the notification. This attribute only applies to 'EMAIL' notifications channel, of type 'PAYIN', 'PAYOUT'.","minimum":0},"timesToRun":{"type":"array","description":"Times of the day when to trigger the notification. This attribute applies only to 'EMAIL' notifications channel, of type 'BALANCE'.","items":{"type":"string","enum":["AM","PM"]}},"daysToRun":{"type":"array","description":"Days of the week when to trigger the notification. This attribute applies only to 'EMAIL' notifications channel, of type 'BALANCE'.","items":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"retry":{"type":"boolean","description":"Flag indicating whether failed webhooks should be retried. This attribute applies only to 'WEBHOOK' notifications channel."},"secret":{"type":"string","description":"Mandatory for webhook. Secret that is used in HMAC calculation, for webhooks. This attribute applies only to 'WEBHOOK' notifications channel.","maxLength":32,"minLength":32},"hmacAlgorithm":{"type":"string","description":"Signing algorithm that is used in Webhook HMAC calculation. This attribute only applies to 'WEBHOOK' notifications channel.","enum":["hmac-sha1","hmac-sha256","hmac-sha384","hmac-sha512"]}}},"account.Test":{"allOf":[{"$ref":"#/components/schemas/account.PatchOperation"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/account.JsonNode"}}}],"description":"Test field","required":["op","path","value"]},"card.AsyncTaskPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/card.AsyncTaskResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"integrationnotification.PaginatedWebhookNotificationResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of Webhook Notification records","items":{"$ref":"#/components/schemas/integrationnotification.WebhookNotificationResponse"}},"size":{"type":"integer","format":"int32","description":"Number of records returned in the current page"},"totalSize":{"type":"integer","format":"int64","description":"Total number of matching failure records"},"page":{"type":"integer","format":"int32","description":"Current page number (0-based)"},"totalPages":{"type":"integer","format":"int32","description":"Total number of pages available"}}},"onboarding.SubmitAssociateResponse":{"type":"object","properties":{"id":{"type":"string"}}},"account.AccessGroupWithDetailsResponse":{"type":"object","description":"AccessGroupWithDetails","properties":{"id":{"type":"string","description":"Unique ID for the access group","example":"G0000001"},"name":{"type":"string","description":"Access group name"},"type":{"type":"string","description":"The type of access group","enum":["SERVICE_PARTNER","SERVICE_CUSTOMER","DELEGATE","USER_DEFINED"]},"typeId":{"type":"string","description":"The identifier of the linked entity implied by the type, e.g. the partner ID"},"status":{"type":"string","description":"Status of the access group","enum":["ACTIVE","DELETED"]},"countOfAccounts":{"type":"integer","format":"int64","deprecated":true,"description":"The number of accounts in this group"},"accountIds":{"type":"array","description":"BIDs of Accounts in the group","items":{"type":"string"},"uniqueItems":true},"beneficiaryIds":{"type":"array","description":"BIDs of Beneficiaries in the group","items":{"type":"string"},"uniqueItems":true}}},"card.CardEnquiryRequest":{"type":"object","description":"Enquiry","properties":{"pan":{"type":"string","description":"pan"},"providerSuppliedId":{"type":"string","description":"providerSuppliedId"}}},"onboarding.CustomerTaxProfileResponse":{"type":"object","properties":{"taxIdentifier":{"type":"string","description":"Tax identifier for customers of type SOLETRADER. Optional for type SOLETRADER, not to be set for non-SOLETRADER customers."}},"required":["taxIdentifier"]},"channelmanager.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"onboarding.Travel":{"type":"object","properties":{"travelBodyDoc":{"$ref":"#/components/schemas/onboarding.DocumentInfo"}}},"channelmanager.Move":{"allOf":[{"$ref":"#/components/schemas/channelmanager.PatchOperation"},{"type":"object","properties":{"from":{"type":"string","example":"/path/to/originating/field"}}}],"description":"Move field","required":["from","op","path"]},"customercompliance.TaxResidenciesRequest":{"type":"object","properties":{"taxResidencies":{"type":"array","description":"List of ISO Alpha-2 country codes where the associate is tax-resident (e.g., [\"ES\", \"FR\"])","items":{"type":"string","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]}}}},"directdebit.DirectDebitPageResponseCollectionScheduleResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/directdebit.CollectionScheduleResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0-based, i.e first page = 0, second page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"account.CustomerComplianceDataResponse":{"type":"object","properties":{"typeDescription":{"type":"string"},"riskLevel":{"type":"string","enum":["LOW","MEDIUM","HIGH","UNDETERMINED"]},"vulnerabilityReasons":{"type":"array","items":{"type":"string","enum":["LIFE_EVENTS","HEALTH","RESILIENCE","CAPABILITY","FINANCIAL_DIFFICULTY"]}},"business":{"$ref":"#/components/schemas/account.BusinessDataResponse"},"consumer":{"$ref":"#/components/schemas/account.ConsumerDataResponse"}}},"account.PatchOperation":{"type":"object","discriminator":{"propertyName":"op","mapping":{"add":"#/components/schemas/account.Add","move":"#/components/schemas/account.Move","test":"#/components/schemas/account.Test","replace":"#/components/schemas/account.Replace","copy":"#/components/schemas/account.Copy","remove":"#/components/schemas/account.Remove"}},"properties":{"op":{"type":"string"},"path":{"type":"string","example":"/path/to/field"}},"required":["op","path"]},"account.IdentifierCountrySpecificDetailsResponse":{"type":"object","properties":{"bankName":{"type":"string","description":"The name of the destination bank.","example":"Apple Bank"},"bankAddress":{"type":"string","description":"The address of the destination bank.","example":"2100 Broadway"},"bankCity":{"type":"string","description":"The city in which the destination bank resides.","example":"New York City"},"bankBranchName":{"type":"string","description":"The name of the destination bank's branch.","example":"New York"},"bankBranchCode":{"type":"string","description":"The code of the destination bank's branch.","example":"44-04"},"bankCode":{"type":"string","description":"The code identifying the target bank on its respective national network. This is not the BIC/SWIFT code. This is known as the 'ABA code' in the U.S., 'ISFC' in India, 'routing number' in Canada, and so on."},"chineseId":{"type":"string","description":"The 18 digit identification code of the beneficiary. Applies to Chinese beneficiaries only.","example":"01101201901018889"},"province":{"type":"string","description":"The province in which the beneficiary resides. Applies only to beneficiaries residing in China.","example":"Zhejiang"},"business":{"type":"boolean","description":"The type of the beneficiary. 'true' for businesses, 'false' otherwise.","example":true},"bankCodeType":{"type":"string","description":"The code type identifying the target bank on its respective national network.\nThis is known as the 'ABA code' in the U.S., 'ISFC' in India, 'routing number' in Canada, and so on.","enum":["ABA","CHIPS"],"example":"ABA"},"bankCountry":{"type":"string","description":"The country in which the destination bank resides.","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"],"example":"US"},"abaRoutingNumber":{"type":"string","description":"The 9 digit identification code of the beneficiary. Applies to US beneficiaries only.","example":"123456789"}}},"onboarding.ExpectedTransactionalActivityResponse":{"type":"object","properties":{"sourceOfFunds":{"type":"string"},"monthlyVolume":{"type":"integer","format":"int32"},"outboundPaymentJurisdictions":{"type":"array","items":{"type":"string","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]}}}},"directdebit.IndemnityClaimDirectDebitResponse":{"type":"object","properties":{"amount":{"type":"number"},"collectionDate":{"type":"string","format":"date"},"collectionId":{"type":"string"}}},"confirmationofpayee.JsonOutboundCopResult":{"type":"object","description":"Account Name Check Result","properties":{"code":{"type":"string","description":"The result of the account name check.","enum":["MATCHED","NOT_MATCHED","CLOSE_MATCH","BUSINESS_ACCOUNT_NAME_MATCHED","PERSONAL_ACCOUNT_NAME_MATCHED","BUSINESS_ACCOUNT_CLOSE_MATCH","PERSONAL_ACCOUNT_CLOSE_MATCH","ACCOUNT_DOES_NOT_EXIST","SECONDARY_ACCOUNT_ID_NOT_FOUND","ACCOUNT_NOT_SUPPORTED","ACCOUNT_SWITCHED","WRONG_PARTICIPANT","NO_RESPONSE","NOT_ENROLLED"],"example":"MATCHED"},"name":{"type":"string","description":"The actual name on the account (as provided by the participating organisation).","example":"Joseph Bloggs"}},"required":["code"]},"channelmanager.reportSubjectIds":{"type":"array","description":"Report subject Ids (Customer BID, Partner BID or Channel Manager BID)","example":"C1000001","items":{"type":"string","description":"Report subject Ids (Customer BID, Partner BID or Channel Manager BID)","example":"C1000001"}},"rule.RuleResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for a Rule","example":"R1000001"},"type":{"type":"string","description":"The type of Rule. Can be one of the following {SWEEP, SPLIT, FUNDING}","enum":["SPLIT","SWEEP","FUNDING"]},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Rule's name","example":"My new rule"},"accountId":{"type":"string","description":"The Account which the Rule is created on.","example":"A1000001"},"accountCurrency":{"type":"string","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"masterId":{"type":"string","description":"The master rule ID. When a rule is changed, the original is marked as inactive, and a new one created. The master ID enables us to identify those rules which are updates","example":"M1000001"},"data":{"$ref":"#/components/schemas/rule.RuleConfigData"}},"required":["accountCurrency","accountId","data","id","masterId","name","type"]},"account.AccountResponse":{"type":"object","description":"Account","properties":{"id":{"type":"string","description":"Unique id for the account","example":"A0000001"},"name":{"type":"string","description":"Name for the account"},"balance":{"type":"string","description":"Balance of the account in format 'NN.NN'","example":"10000.00"},"availableBalance":{"type":"string","description":"The current available balance of the Account. Calculated by subtracting any pending payments from the current balance","example":"10000.00"},"currency":{"type":"string","description":"Currency of the account in ISO 4217 format","example":"GBP"},"status":{"type":"string","description":"Status of the account. Accounts must be 'ACTIVE' to make and receive payments. Can be one of ","example":"ACTIVE"},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/account.IdentifierResponse"}},"customerId":{"type":"string","description":"Unique id of the Customer","example":"C0000001"},"customerName":{"type":"string","description":"Customer Name"},"externalReference":{"type":"string","description":"Your reference for an account","example":"aReference_00001"},"accessGroups":{"type":"array","description":"Ids of Access Groups this account belongs to","items":{"type":"string"}},"createdDate":{"type":"string","format":"date-time","description":"Datetime when the account was created. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000"},"directDebit":{"type":"boolean","description":"Direct Debit Enabled"},"securedFundingLimit":{"type":"string","description":"Limit of funds available below a balance of zero"}}},"card.UpdateCardRequest":{"type":"object","description":"Update card","properties":{"limit":{"type":"number","description":"Total card authorisation limit.","example":"1000.00"},"cancellationDate":{"type":"string","description":"ISO 8601 date with year, month & day components only. The supplied value must be in the future and at most 1 day before the expiry date.","example":"2025-01-01"},"customFields":{"type":"array","description":"Custom fields","items":{"$ref":"#/components/schemas/card.CardCustomFieldRequest"},"maxItems":20,"minItems":1},"holder":{"$ref":"#/components/schemas/card.UpdateCardHolder","description":"CardHolder"},"authWindow":{"$ref":"#/components/schemas/card.AuthorisationWindowRequest","description":"Authorisation Windows allow the card holder to add a period of time where the card can ONLY be used, if an Authorisation Window set then transactions outside this window will decline. ISO 8601 date with year, month & day components only."}}},"card.reportSubjectIds":{"type":"array","description":"Report subject Ids (Customer BID, Partner BID or Channel Manager BID)","example":"C1000001","items":{"type":"string","description":"Report subject Ids (Customer BID, Partner BID or Channel Manager BID)","example":"C1000001"}},"payment.OverseasAccountIdentifier":{"type":"object","properties":{"iban":{"type":"string","description":"International Bank Account Number (IBAN)","example":"GB20MODR00000000000001","pattern":"^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{1,30}$"},"bban":{"type":"string","description":"Basic Bank Account Number (BBAN)","example":"NWBK60161331926819","pattern":"^[a-zA-Z0-9]{1,30}$"},"upic":{"type":"string","description":"Universal Payment Identification Code (UPIC)","example":"987654321","pattern":"^\\d{8,17}$"},"otherAccountNumber":{"type":"string","description":"Other Account ID","example":"987654321","pattern":"^[a-zA-Z0-9]{1,34}$"}}},"channelmanager.PatchOperation":{"type":"object","discriminator":{"propertyName":"op","mapping":{"add":"#/components/schemas/channelmanager.Add","move":"#/components/schemas/channelmanager.Move","test":"#/components/schemas/channelmanager.Test","replace":"#/components/schemas/channelmanager.Replace","copy":"#/components/schemas/channelmanager.Copy","remove":"#/components/schemas/channelmanager.Remove"}},"properties":{"op":{"type":"string"},"path":{"type":"string","example":"/path/to/field"}},"required":["op","path"]},"account.SourceOfWealthRequest":{"type":"object","properties":{"standard":{"type":"string"},"pep":{"type":"string"}}},"directdebit.CollectionScheduleResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique id for direct-debit collection.","example":"Q0000001"},"frequency":{"type":"string","description":"Frequency for direct-debit collection","example":"MONTHLY"},"numberOfPayments":{"type":"integer","format":"int32","description":"Number of payments for direct-debit collection","example":12},"firstPaymentAmount":{"type":"number","description":"Amount of the first collection payment","example":"100.00"},"firstPaymentDate":{"type":"string","description":"Date of the first collection payment. Format is yyyy-MM-dd.","example":"2018-01-10"},"regularPaymentAmount":{"type":"number","description":"Amount of the regular collection payments","example":"100.00"},"regularPaymentStartDate":{"type":"string","description":"Start date of the regular collection payment. Format is yyyy-MM-dd.","example":"2018-01-10"},"createdDate":{"type":"string","format":"date-time","description":"Datetime when direct-debit collection was created.Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000"},"status":{"type":"string","description":"Status of the direct-debit collection. Can be one of ","example":"PROCESSING"},"externalReference":{"type":"string"},"collectionReference":{"type":"string"}},"required":["createdDate","frequency","id","numberOfPayments","status"]},"payment.paymentStatuses":{"type":"array","items":{"type":"string","description":"Current status of payment. Multiple statuses can be specified by repeating the parameter.","enum":["SUBMITTED","SCREENING_REQ","VALIDATED","PENDING_FOR_DATE","PENDING_FOR_FUNDS","EXT_PROC","PROCESSED","RECONCILED","ER_INVALID","ER_EXTCONN","ER_EXTSYS","ER_EXPIRED","ER_GENERAL","ER_BATCH","EXT_SENT","UNALLOCATED","HELD","RETURNED","CANCELLED","REPROCESSING","VOID","CLEARING","HELD_IN_SUSPENSE"]}},"document.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"pispgateway.PaymentConstraints":{"type":"object","description":"Limits that will apply to payments initiated using this consent. ","properties":{"maximumIndividualAmount":{"$ref":"#/components/schemas/pispgateway.MaximumIndividualVrPayment","description":"Maximum amount of any single payment initiated using this consent."},"periodicLimits":{"type":"array","description":"Maximum amount of all payments that can be initiated using this consent in a given period. If the periodAlignment is “Calendar”, the limit is pro-rated in the first period to the remaining number of days.","items":{"$ref":"#/components/schemas/pispgateway.PeriodicLimit"}}},"required":["maximumIndividualAmount"]},"customercompliance.Department":{"type":"object","properties":{"departmentCode":{"type":"string","description":"3 or 4 character code representing an individual's department code"}}},"payment.batchPaymentStatuses":{"type":"array","items":{"type":"string","description":"Current status of batch. Multiple statuses can be specified by repeating the parameter.","enum":["ACCEPTED","REJECTED","SUBMITTED","CANCELLED"]}},"cardsimulator.CardAccountStatusInquiryResponse":{"type":"object","description":"CardAccountStatusInquiryResponse","properties":{"cardId":{"type":"string","description":"Card Id","example":"V000000001"},"status":{"type":"string","description":"Account status inquiry result [APPROVED, DECLINED]","enum":["APPROVED","DECLINED"],"example":"APPROVED"}},"required":["cardId","status"]},"channelmanager.ReportResponse":{"type":"object","properties":{"id":{"type":"string"},"reportSubjectId":{"type":"string"},"reportDate":{"type":"string","format":"date"},"reportType":{"type":"string","enum":["DAILY_CARD_ACTIVITY","MONTHLY_CARD_ACTIVITY","DAILY_ACCOUNT_FUNDING","MONTHLY_ACCOUNT_FUNDING","DAILY_AUTH_WINDOW","DAILY_CARD_MANAGEMENT"]}}},"account.BeneficiaryLockResponse":{"type":"object","description":"BeneficiaryLock","properties":{"ownerId":{"type":"string","description":"Reference for the entity owning the lock.","example":"R00000001A"},"ownerType":{"type":"string","description":"Entity type owning the lock.","enum":["RULE","PAYMENT"]}}},"card.CardActivityPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/card.CardActivityResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"payment.PaymentsSummary":{"type":"object","description":"Summary of payments and approvals","properties":{"totalPaymentCount":{"type":"integer","format":"int32","description":"Total count of payments","example":10},"totalAmount":{"type":"number","description":"Sum total of payment amounts","example":"100.00"},"pendingApprovalCount":{"type":"integer","format":"int32","description":"Count of payments currently pending approval","example":5},"pendingApprovalAmount":{"type":"number","description":"Sum total of payment amounts currently pending approval","example":"50.00"}}},"integrationnotification.WebhookNotificationResponse":{"type":"object","description":"Response object for integration notification operations. Contains all common fields from WebhookNotificationRequestBase, along with the notification ID and type.","properties":{"id":{"type":"string","description":"Unique Identifier for the notification"},"url":{"type":"string","description":"The URL used for sending the notification.","minLength":1},"retry":{"type":"boolean","description":"Flag indicating whether failed webhooks should be retried."},"secret":{"type":"string","description":"Secret that is used in HMAC calculation for webhooks.","maxLength":32,"minLength":32},"hmacAlgorithm":{"type":"string","description":"HMAC signing algorithm used to calculate the webhook signature.","enum":["hmac-sha1","hmac-sha256","hmac-sha384","hmac-sha512"]},"type":{"type":"string","description":"Type of the notification.","enum":["PAYOUT","PAYIN","CARD_AUTH","CARD_AUTH_OFFLINE","CARD_STATUS_UPDATE","PAYMENT_COMPLIANCE_STATUS"]},"webhookTypeConfiguration":{"$ref":"#/components/schemas/integrationnotification.WebhookTypeConfiguration","description":"Value used to determine whether payin webhooks should be sent or not."}},"required":["hmacAlgorithm","id","retry","secret","type","url"]},"customercompliance.AssociateSearchCriteria":{"type":"object","properties":{"additionalIdentifier":{"$ref":"#/components/schemas/customercompliance.AssociateAdditionalIdentifier","description":"Additional personal identifier"},"page":{"type":"integer","format":"int32","description":"Page to fetch (0 indexed)","minimum":0},"size":{"type":"integer","format":"int32","description":"Size of page to fetch","maximum":500}}},"payment.DestinationCountrySpecificDetails":{"type":"object","properties":{"bankName":{"type":"string","description":"The name of the destination bank.","example":"Apple Bank"},"bankAddress":{"type":"string","description":"The address of the destination bank.","example":"2100 Broadway"},"bankCity":{"type":"string","description":"The city in which the destination bank resides.","example":"New York City"},"bankBranchName":{"type":"string","description":"The name of the destination bank's branch.","example":"New York"},"bankBranchCode":{"type":"string","description":"The code of the destination bank's branch.","example":"44-04"},"bankCode":{"type":"string","description":"The code identifying the target bank on its respective national network. This is not the BIC/SWIFT code. This is known as the 'ABA code' in the U.S., 'ISFC' in India, 'routing number' in Canada, and so on."},"chineseId":{"type":"string","description":"The 18 digit identification code of the beneficiary. Applies to Chinese beneficiaries only.","example":"01101201901018889"},"province":{"type":"string","description":"The province in which the beneficiary resides. Applies only to beneficiaries residing in China.","example":"Zhejiang"},"abaRoutingNumber":{"type":"string","description":"The 9 digit identification code of the beneficiary. Applies to US beneficiaries only.","example":"123456789","pattern":"^\\d{9}$"},"business":{"type":"boolean","description":"The type of the beneficiary. 'true' for businesses, 'false' otherwise.","example":true},"bankCodeType":{"type":"string","description":"The code type identifying the target bank on its respective national network.\nThis is known as the 'ABA code' in the U.S., 'ISFC' in India, 'routing number' in Canada, and so on.","enum":["ABA","CHIPS"],"example":"ABA"},"bankCountry":{"type":"string","description":"The country in which the destination bank resides. Mandatory for international payments.","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"],"example":"US"}}},"onboarding.CustomerIdentificationInformation":{"type":"object","properties":{"country":{"type":"string","description":"The issuing country code in ISO Alpha-2 format","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"type":{"type":"string","description":"Identifier type","enum":["INSEE"]},"value":{"type":"string","description":"The identification value","pattern":"^[A-Za-z0-9]{4}$"}}},"onboarding.SubmitApplicationResponse":{"type":"object","properties":{"id":{"type":"string"}}},"account.AssociateComplianceDataResponse":{"type":"object","properties":{"relationship":{"type":"string"}}},"account.CustomerPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/account.Customer"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}}},"rule.SplitConfig":{"type":"object","description":"Configuration for a Split Rule","properties":{"destinationId":{"type":"string","description":"Id of destination beneficiary. e.g. B1000001."},"percent":{"type":"string","description":"Percentage of payment to be moved to specified destination. e.g. 7.25.","minLength":1}},"required":["destinationId","percent"]},"card.CreatePhysicalCardRequest":{"type":"object","description":"Card","properties":{"limit":{"type":"number","format":"double","description":"Total card authorisation limit.","example":"1000.00","maximum":99999999.99,"minimum":1},"expiry":{"type":"string","description":"ISO 8601 date with year & month components only. The supplied value must be in the future (cannot be the current month) and is _inclusive_ of the specified month.","example":"2018-12"},"productCode":{"type":"string","description":"Identifies the _type_ of card to create (GBP consumer, GBP business, etc). Modulr will supply a list of possible values."},"externalRef":{"type":"string","description":"Client reference for the newly created card. Maximum of 50 alphanumeric characters (including underscore, hyphen and space).","maxLength":50,"minLength":1,"pattern":"[\\w -]*"},"constraints":{"$ref":"#/components/schemas/card.Constraints","description":"Constraints"},"authentication":{"$ref":"#/components/schemas/card.CardAuthentication","description":"Authentication. Required by default, optional for Virtual Business Travel Cards only"},"cancellationDate":{"type":"string","description":"Date for card to be cancelled on","example":"2025-01-01"},"customFields":{"type":"array","description":"Custom fields of card","items":{"$ref":"#/components/schemas/card.CardCustomFieldRequest"},"maxItems":20,"minItems":0},"authorisationWindow":{"$ref":"#/components/schemas/card.AuthorisationWindowRequest","description":"Authorisation Windows allow the card holder to add a period of time where the card can ONLY be used, if an Authorisation Window set then transactions outside this window will decline. ISO 8601 date with year, month & day components only."},"frequencyUsage":{"type":"string","enum":["SINGLE_USE","MULTI_USE"]},"holder":{"$ref":"#/components/schemas/card.CardHolder","description":"CardHolder"},"shippingAddress":{"$ref":"#/components/schemas/card.AddressDetail","description":"Add a Shipping address if you wish the card to be sent to an address other than the billing address"},"design":{"$ref":"#/components/schemas/card.ProductDesignDetail","description":"Design references for card and packaging"},"printedName":{"type":"string","description":"Name to be printed on the card. Maximum of 27 alphanumeric characters (including full stop, hyphen, apostrophe, caret and space). Please add business name to this field if you wish to have it on the card.","example":"Joe Bloggs","maxLength":27,"minLength":1,"pattern":"[a-zA-Z 0-9À-ŽȘȚ'’.,^-]{1,27}"}},"required":["design","expiry","externalRef","limit","printedName","productCode"]},"account.ConsumerDataResponse":{"type":"object","properties":{"employment":{"type":"string"},"natureOfRelationship":{"type":"string"},"expectedTransactionalActivity":{"$ref":"#/components/schemas/account.ExpectedTransactionalActivityResponse"},"screeningResults":{"$ref":"#/components/schemas/account.ScreeningResultsResponse"},"sourceOfWealth":{"$ref":"#/components/schemas/account.SourceOfWealthResponse"}}},"channelmanager.Copy":{"allOf":[{"$ref":"#/components/schemas/channelmanager.PatchOperation"},{"type":"object","properties":{"from":{"type":"string","example":"/path/to/originating/field"}}}],"description":"Copy field","required":["from","op","path"]},"customercompliance.KnowYourCustomer":{"type":"object","properties":{"tradingName":{"type":"string","description":"The trading name of the business"},"incorporationDate":{"type":"string","format":"date","description":"Incorporation Date of the business"},"businessActivities":{"type":"string","description":"The business activities of the business"},"onlinePresenceUrl":{"type":"string","description":"The online presence URL of the business"},"expectedMonthlyTransactions":{"type":"integer","format":"int64","description":"Expected Monthly Transactions of the business"},"expectedMonthlySpend":{"type":"integer","format":"int64","description":"Expected Monthly Spend of the business"},"industryCode":{"type":"string","description":"The industry code of the business","maxLength":6,"minLength":0}}},"channelmanager.UpdateCardHolder":{"type":"object","properties":{"billingAddress":{"$ref":"#/components/schemas/channelmanager.AddressDetail","description":"Billing address for the card holder. Must be NULL for individual customers."},"shippingAddress":{"$ref":"#/components/schemas/channelmanager.AddressDetail","description":"Shipping address details for card. Optional for individual customers whose partner has verification type EXTERNAL"},"dateOfBirth":{"type":"string","format":"date","description":"Cardholder date of birth. Must match date format of yyyy-mm-dd. Required for virtual consumer and physical cards. Must be NULL for individual customers.","example":"2001-01-01"},"mobileNumber":{"type":"string","description":"Cardholder mobile number. Must start with a '+', followed by the country code and then the mobile number. Required for virtual consumer and physical cards.","example":"+447123456000"},"email":{"type":"string","format":"email","description":"Cardholder email","example":"cardholder@example.com","maxLength":50,"minLength":0}}},"onboarding.CustomerTrustRequest":{"type":"object","properties":{"trustNature":{"type":"string","description":"Trust nature for customers of type Trust. Mandatory for type Trust, not to be set for non-trust customers.","enum":["BARE_TRUSTS","INTEREST_IN_POSSESSION_TRUSTS","DISCRETIONARY_TRUSTS","ACCUMULATION_TRUSTS","MIXED_TRUSTS","SETTLOR_INTERESTED_TRUSTS","NON_RESIDENT_TRUSTS","OFFSHORE_TRUSTS","FAMILY_LIVING_TRUST","PILOT_TRUST","VULNERABLE_BENEFICIARY_TRUST","CHARITABLE_TRUSTS","IRREVOCABLE_LIFE_INSURANCE_TRUST","TESTAMENTARY_TRUSTS","OTHER"]}},"required":["trustNature"]},"account.AccountSecuredFundingRequest":{"type":"object","properties":{"limit":{"type":"number","description":"Secured funding limit","minimum":0}},"required":["limit"]},"card.BulkRequestResponse":{"type":"object","description":"Bulk card request details","properties":{"id":{"type":"string","description":"Bulk request ID","example":"B000000001"},"filename":{"type":"string","description":"Filename of the uploaded file","example":"example.csv"},"createdDate":{"type":"string","format":"date-time","description":"Date and time when the bulk request was created"},"createdBy":{"type":"string","description":"User ID who created the bulk request","example":"U000001"},"status":{"type":"string","description":"Status of the bulk request","example":"VALIDATED_WITH_ERRORS"},"totalOperations":{"type":"integer","format":"int64","description":"Total number of operations in the bulk request","example":200},"successfulOperations":{"type":"integer","format":"int64","description":"Number of successful operations","example":194},"failedOperations":{"type":"integer","format":"int64","description":"Number of failed operations","example":6},"processedOperations":{"type":"integer","format":"int64","description":"Number of processed operations","example":142},"externalRef":{"type":"string","description":"External reference","example":"example ref"}},"required":["createdBy","createdDate","failedOperations","id","status","successfulOperations","totalOperations"]},"integrationnotification.WebhookNotificationRequest":{"type":"object","description":"Request object used to create/update a new integration notification.","properties":{"url":{"type":"string","description":"The URL used for sending the notification.","minLength":1},"retry":{"type":"boolean","description":"Flag indicating whether failed webhooks should be retried."},"secret":{"type":"string","description":"Secret that is used in HMAC calculation for webhooks.","maxLength":32,"minLength":32},"hmacAlgorithm":{"type":"string","description":"HMAC signing algorithm used to calculate the webhook signature.","enum":["hmac-sha1","hmac-sha256","hmac-sha384","hmac-sha512"]},"type":{"type":"string","description":"Type of the notification.","enum":["PAYOUT","PAYIN","CARD_AUTH","CARD_AUTH_OFFLINE","CARD_STATUS_UPDATE","PAYMENT_COMPLIANCE_STATUS"]},"webhookTypeConfiguration":{"$ref":"#/components/schemas/integrationnotification.WebhookTypeConfiguration","description":"Value used to determine whether payin webhooks should be sent or not."}},"required":["hmacAlgorithm","retry","secret","type","url"]},"account.AdditionalPersonalIdentifierResponse":{"type":"object","description":"AdditionalPersonalIdentifier","properties":{"type":{"type":"string","description":"The type of Additional Personal Identifier","enum":["BSN"]},"value":{"type":"string","description":"Additional Personal Identifier value"}}},"directdebit.accountId":{"type":"array","description":"Id(s) of account to fetch Mandates for.","items":{"type":"string","description":"Id(s) of account to fetch Mandates for."}},"payment.id":{"type":"array","description":"List of batch payment IDs","items":{"type":"string","description":"List of batch payment IDs"}},"paymentfileupload.FileUploadResponse":{"type":"object","properties":{"fileId":{"type":"string","description":"Unique id of the uploaded file","example":"F1100001","minLength":1}},"required":["fileId"]},"verificationofpayee.OutboundVopRequest":{"type":"object","description":"Verify Payee Request","properties":{"name":{"type":"string","description":"The name of the payee.","example":"John Smith","maxLength":140,"minLength":1},"iban":{"type":"string","description":"The IBAN of the payee.","example":"AD1200012030200359100100"},"paymentAccountId":{"type":"string","description":"The bid of the account the payment will be initiated from.","example":"A123AAA4"},"customerId":{"type":"string","description":"The bid of the customer that is making this request.","example":"C1100001"}},"required":["iban","name","paymentAccountId"]},"channelmanager.WebhookNotificationPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/channelmanager.WebhookNotificationResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"channelmanager.ProductDesignDetail":{"type":"object","properties":{"cardRef":{"type":"string","description":"Design reference for card","minLength":1},"packagingRef":{"type":"string","description":"Design reference for card packaging","minLength":1}},"required":["cardRef","packagingRef"]},"customercompliance.CreateBusinessResponse":{"type":"object","properties":{"id":{"type":"string","description":"Business ID"}}},"onboarding.CustomerComplianceDataRequest":{"type":"object","properties":{"typeDescription":{"type":"string","description":"Required for customers of type PREQUALIFIED. Not allowed for all other customer types.","maxLength":200,"minLength":0},"riskLevel":{"type":"string","description":"Risk level of the customer","enum":["LOW","MEDIUM","HIGH","UNDETERMINED"]},"vulnerabilityReasons":{"type":"array","description":"Vulnerability Reasons of the customer","items":{"type":"string","enum":["LIFE_EVENTS","HEALTH","RESILIENCE","CAPABILITY","FINANCIAL_DIFFICULTY"]}},"business":{"$ref":"#/components/schemas/onboarding.BusinessDataRequest","description":"Business data of the customer"},"consumer":{"$ref":"#/components/schemas/onboarding.ConsumerDataRequest","description":"Consumer data of the customer"}}},"customercompliance.CustomerIdentificationInformation":{"type":"object","properties":{"country":{"type":"string","description":"The issuing country code in ISO Alpha-2 format","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"type":{"type":"string","description":"Identifier type","enum":["INSEE"]},"value":{"type":"string","description":"The identification value","pattern":"^[A-Za-z0-9]{4}$"}}},"account.UpdateBrandNameRequest":{"type":"object","properties":{"id":{"type":"string","description":"Unique id for the Brand Name"},"name":{"type":"string","description":"The Brand Name"}}},"payment.customerId":{"type":"array","description":"Filter on customer ID","example":"C1234567","items":{"type":"string","description":"Filter on customer ID","example":"C1234567"}},"payment.BatchPaymentSummary":{"type":"object","properties":{"total":{"type":"integer","format":"int32","description":"Total count of payment requests in this batch"},"invalid":{"type":"integer","format":"int32","description":"Count of invalid payment requests"},"inprogress":{"type":"integer","format":"int32","description":"Count of payment requests in progress"},"completed":{"type":"integer","format":"int32","description":"Count of completed payments"},"errors":{"type":"integer","format":"int32","description":"Count of failed payment requests"},"cancelled":{"type":"integer","format":"int32","description":"Count of cancelled payment requests"},"info":{"type":"string","description":"Additional information or error message regarding this batch payment request"},"strict":{"type":"boolean"}}},"channelmanager.UpdateCardRequest":{"type":"object","description":"Card","properties":{"limit":{"type":"number","description":"Total card authorisation limit.","example":"1000.00"},"cancellationDate":{"type":"string","description":"ISO 8601 date with year, month & day components only. The supplied value must be in the future and at most 1 day before the expiry date.","example":"2025-01-01"},"customFields":{"type":"array","description":"Custom fields","items":{"$ref":"#/components/schemas/channelmanager.CardCustomFieldRequest"},"maxItems":20,"minItems":1},"holder":{"$ref":"#/components/schemas/channelmanager.UpdateCardHolder","description":"CardHolder"},"authWindow":{"$ref":"#/components/schemas/channelmanager.AuthorisationWindowRequest","description":"Authorisation Windows allow the card holder to add a period of time where the card can ONLY be used, if an Authorisation Window set then transactions outside this window will decline. ISO 8601 date with year, month & day components only."}}},"card.CardPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/card.CardResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"card.CustomFields":{"type":"object","properties":{"key":{"type":"string","description":"Custom field key"},"required":{"type":"boolean","description":"Whether the custom field is required or not"}},"required":["key","required"]},"card.SpendConstraintDetail":{"type":"object","description":"Spending constraints","properties":{"currency":{"type":"string","description":"A 3 letter ISO 4217 code representing the transaction currency","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"GBP"},"min":{"type":"number","description":"Minimum spend amount (inclusive)","example":"5.00"},"max":{"type":"number","description":"Maximum spend amount (inclusive)","example":"2000.00"}},"required":["currency"]},"account.IdentifierCountrySpecificDetailsRequest":{"type":"object","properties":{"bankName":{"type":"string","description":"The name of the destination bank.","example":"Apple Bank","maxLength":140,"minLength":0},"bankAddress":{"type":"string","description":"The address of the destination bank.","example":"2100 Broadway","maxLength":70,"minLength":0},"bankCity":{"type":"string","description":"The city in which the destination bank resides.","example":"New York City","maxLength":35,"minLength":0},"bankBranchName":{"type":"string","description":"The name of the destination bank's branch.","example":"New York"},"bankBranchCode":{"type":"string","description":"The code of the destination bank's branch.","example":"44-04","maxLength":35,"minLength":0},"bankCode":{"type":"string","description":"The code identifying the target bank on its respective national network. This is not the BIC/SWIFT code. This is known as the 'ABA code' in the U.S., 'ISFC' in India, 'routing number' in Canada, and so on.","maxLength":35,"minLength":0},"chineseId":{"type":"string","description":"The 18 digit identification code of the beneficiary. Applies to Chinese beneficiaries only.","example":"01101201901018889"},"province":{"type":"string","description":"The province in which the beneficiary resides. Applies only to beneficiaries residing in China.","example":"Zhejiang"},"business":{"type":"boolean","description":"The type of the beneficiary. 'true' for businesses, 'false' otherwise.","example":true},"bankCodeType":{"type":"string","description":"The code type identifying the target bank on its respective national network.\nThis is known as the 'ABA code' in the U.S., 'ISFC' in India, 'routing number' in Canada, and so on.","enum":["ABA","CHIPS"],"example":"ABA"},"bankCountry":{"type":"string","description":"The country in which the destination bank resides.","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"],"example":"US"},"abaRoutingNumber":{"type":"string","description":"The 9 digit identification code of the beneficiary. Applies to US beneficiaries only.","example":"123456789","pattern":"^\\d{9}$"}}},"channelmanager.CardConstraints":{"type":"object","properties":{"mccWhitelist":{"type":"array","description":"mccWhitelist","example":["1000","1002-3000","5060"],"items":{"type":"string"}},"authorisation":{"$ref":"#/components/schemas/channelmanager.AuthorisationConstraints","description":"Authorisation constraints"}},"required":["mccWhitelist"]},"directdebit.IndemnityClaimResponse":{"type":"object","properties":{"id":{"type":"string"},"accountBid":{"type":"string"},"serviceUserReference":{"type":"string"},"ddicReference":{"type":"string"},"reasonCode":{"type":"string","enum":["AMOUNT_OR_DATE_DIFFER","NO_ADVANCE_NOTICE","DDI_CANCELLED_BY_BANK","DDI_CANCELLED_WITH_SERVICE_USER","NO_INSTRUCTION","INVALID_SIGNATURE","SERVICE_USER_REQUEST","SERVICE_USER_NAME_DISPUTED"]},"amount":{"type":"number"},"payingBankName":{"type":"string"},"payingBankSortCode":{"type":"string"},"payingBankAccountNumber":{"type":"string"},"payingBankServiceUserNumber":{"type":"string"},"statusHistory":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.IndemnityClaimStatusHistoryResponse"}},"status":{"type":"string","enum":["NEW","CANCELLED","SETTLED"]},"directDebits":{"type":"array","items":{"$ref":"#/components/schemas/directdebit.IndemnityClaimDirectDebitResponse"}}}},"payment.Address":{"type":"object","properties":{"addressLine1":{"type":"string","description":"First line of the ultimate payers address","example":"2nd Floor","maxLength":70,"minLength":0},"addressLine2":{"type":"string","description":"Second line of the ultimate payers address","example":"123 High Street","maxLength":70,"minLength":0},"postTown":{"type":"string","description":"Postal town of the ultimate payers address","example":"Edinburgh","maxLength":35,"minLength":0},"postCode":{"type":"string","description":"Post code of the ultimate payers address","example":"AB12 3XX","maxLength":16,"minLength":0},"country":{"type":"string","description":"ISO 3166 country code of the ultimate payers address","example":"GB"}},"required":["country"]},"card.ShareSecureCardDetailSummaryResponse":{"type":"object","properties":{"id":{"type":"string"},"createdBy":{"type":"string"},"email":{"type":"string"},"status":{"type":"string"},"expiryDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"lastRevealedDate":{"type":"string","format":"date-time"},"noOfAccessesLeft":{"type":"integer","format":"int64"},"maxAccessesAllowed":{"type":"integer","format":"int64"},"message":{"type":"string"},"externalReference":{"type":"string"},"otherDetails":{"type":"array","items":{"type":"object","additionalProperties":{}}},"activity":{"type":"array","items":{"$ref":"#/components/schemas/card.ShareSecureCardDetailsActivity"}},"customerId":{"type":"string"},"customerName":{"type":"string"},"cardScheme":{"type":"string"},"currency":{"type":"string"}}},"account.Replace":{"allOf":[{"$ref":"#/components/schemas/account.PatchOperation"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/account.JsonNode"}}}],"description":"Replace field","required":["op","path","value"]},"card.AuthorisationWindow":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"Authorisation window start date"},"endDate":{"type":"string","format":"date-time","description":"Authorisation window end date"}}},"pispgateway.LegacyPaymentContext":{"type":"object","description":"Payment context for the initiation request","properties":{"paymentContextCode":{"type":"string","description":"Indicates type of Payment Context, can be one of BILLPAYMENT, ECOMMERCEGOODS, ECOMMERCESERVICES, OTHER, PARTYTOPARTY. If no value or paymentContext is provided, PARTYTOPARTY is considered the default value.","enum":["BILLPAYMENT","ECOMMERCEGOODS","ECOMMERCESERVICES","OTHER","PARTYTOPARTY"]},"deliveryAddress":{"$ref":"#/components/schemas/pispgateway.DeliveryAddress","description":"Delivery address, must be specified if paymentContextCode is 'ECOMMERCEGOODS'"},"merchantCategoryCode":{"type":"string","description":"Merchant category code conform to ISO 18245, related to the type of services or goods provided for the transaction. Must be specified if paymentContextCode is either ECOMMERCEGOODS or ECOMMERCESERVICES","maxLength":4,"minLength":3},"merchantCustomerIdentification":{"type":"string","description":"Merchant customer identification, must be specified if paymentContextCode is either ECOMMERCEGOODS or ECOMMERCESERVICES","maxLength":70,"minLength":1}}},"onboarding.CreateCustomerRequest":{"type":"object","description":"Details of customer to create","properties":{"externalReference":{"type":"string","description":"External Reference can only have alphanumeric characters plus underscore, hyphen and space up to 50 characters long","maxLength":50,"minLength":0,"pattern":"[\\w \\-]*"},"name":{"type":"string","description":"AlphaNumeric characters plus [ _ ' @ , & £ $ € ¥ = # % ‘ ’ : ; \\ / < > « »  ! ‘ “ ” . ? - *{ }  + % ( )]. Mandatory for all types except 'INDIVIDUAL and PCM_INDIVIDUAL'","maxLength":100,"minLength":0,"pattern":"^([_'@,&()£$€¥=#%\\‘\\’:;/<>«»\\\"!\\‘\\“\\”.\\?\\-\\s\\*\\{\\}\\[\\]\\+\\%\\\\]*?[\\p{L}0-9])+[_'@,&()£$€¥=#%\\‘\\’:;/<>«»\\\"!\\‘\\“\\”.\\?\\-\\s\\*\\{\\}\\[\\]\\+\\%\\\\]*"},"companyRegNumber":{"type":"string","description":"Company registration number. Mandatory for 'LLC' and 'PLC'","maxLength":40,"minLength":0},"registeredAddress":{"$ref":"#/components/schemas/onboarding.AddressRequest","description":"Mandatory for 'LLC', 'LLP' and 'LPARTNRSHP'"},"tradingAddress":{"$ref":"#/components/schemas/onboarding.AddressRequest","description":"Mandatory for all types except 'INDIVIDUAL' and 'PCM_INDIVIDUAL'"},"industryCode":{"type":"string","description":"Mandatory for all types except 'INDIVIDUAL', 'PCM_INDIVIDUAL' and 'PCM_BUSINESS'. In-house KYC partners -> Refer to Modulr Industry Code list. Outsourced KYC partners -> custom codes allowed.","maxLength":6,"minLength":0},"tcsVersion":{"type":"integer","format":"int32","description":"Terms and conditions version. Mandatory for all types except 'PCM_INDIVIDUAL' and 'PCM_BUSINESS'","maximum":1000,"minimum":1},"type":{"type":"string","description":"Type of the customer, 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. CHARITY -> charity\n8. INDIVIDUAL -> individual consumer\n9. PCM_INDIVIDUAL -> partner clearing model individual consumer\n10. PCM_BUSINESS -> partner clearing model business consumer\n11. TRUST -> trust customer\n12. PREQUALIFIED -> only for use by customers who have been pre-authorised by Modulr","minLength":1},"expectedMonthlySpend":{"type":"integer","format":"int32","description":"Mandatory for all types except 'PCM_INDIVIDUAL' and 'PCM_BUSINESS'","maximum":2147483647,"minimum":0},"associates":{"type":"array","description":"Mandatory for all types except 'PCM_BUSINESS'","items":{"$ref":"#/components/schemas/onboarding.CreateAssociateRequest"}},"documentInfo":{"type":"array","description":"information on uploaded documents","items":{"$ref":"#/components/schemas/onboarding.DocumentInfo"}},"legalEntity":{"type":"string","description":"Legal entity of the customer","enum":["GB","NL","IE"]},"provisionalCustomerId":{"type":"string","description":"Reference to provisional customer in onboarding flow"},"customerTrust":{"$ref":"#/components/schemas/onboarding.CustomerTrustRequest","description":"Trust nature for customers of type Trust. Mandatory for type Trust, not to be set for non-trust customers."},"taxProfile":{"$ref":"#/components/schemas/onboarding.CustomerTaxProfileRequest","description":"Tax profile for customers of type SOLETRADER. Optional for type SOLETRADER, not to be set for non-SOLETRADER customers."},"complianceData":{"$ref":"#/components/schemas/onboarding.CustomerComplianceDataRequest","description":"Required for customers of type PREQUALIFIED."},"consumerDuty":{"$ref":"#/components/schemas/onboarding.ConsumerDuty","description":"Consumer Duty data of the customer"},"knowYourBusiness":{"$ref":"#/components/schemas/onboarding.KnowYourBusiness","description":"Know your business data of the customer"},"accountancy":{"$ref":"#/components/schemas/onboarding.Accountancy","description":"Data provided for the accountancy industry"},"travel":{"$ref":"#/components/schemas/onboarding.Travel","description":"Data provided for the travel industry"},"employmentServices":{"$ref":"#/components/schemas/onboarding.EmploymentServices","description":"Data provided for the employment services industry"},"charity":{"$ref":"#/components/schemas/onboarding.Charity","description":"Data provided for the charity industry"},"legal":{"$ref":"#/components/schemas/onboarding.Legal","description":"Data provided for the legal industry"},"taxIdentifiers":{"type":"array","description":"Tax Identifiers for the customer","items":{"$ref":"#/components/schemas/onboarding.TaxIdentifier"}},"customerIdentificationInfo":{"type":"array","description":"Identification information for the customer","items":{"$ref":"#/components/schemas/onboarding.CustomerIdentificationInformation"}},"construction":{"$ref":"#/components/schemas/onboarding.Construction","description":"Data provided for the construction industry"},"contractCounterparty":{"type":"string","description":"Business unit the customer contracts with","enum":["MFBV","MFSL","MUS"]}},"required":["type"]},"channelmanager.AddressDetail":{"type":"object","description":"Address details for the cardholder. Optional for individual customers whose partner has verification type EXTERNAL.","properties":{"addressLine1":{"type":"string","description":"First line of address","example":"Floor 10","maxLength":50,"minLength":1},"addressLine2":{"type":"string","description":"Second line of address","example":"80 George Street","maxLength":50,"minLength":0},"postTown":{"type":"string","description":"Post town","example":"EDINBURGH","maxLength":20,"minLength":1},"postCode":{"type":"string","description":"Postcode","example":"EH2 3BU","maxLength":10,"minLength":1},"country":{"type":"string","description":"Country (ISO 3166 alpha-2 country code)","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","AX","AW","BL","CW","GF","GL","GP","ME","MF","MQ","NC","PF","PM","RE","SX","TF","WF","YT","AI","BM","FK","GB","GG","GI","GS","IO","JE","KY","MS","PN","SH","TC","VG"],"example":"GB","minLength":1}},"required":["addressLine1","country","postCode","postTown"]},"channelmanager.CardAuthentication":{"type":"object","properties":{"knowledgeBase":{"type":"array","description":"3DS knowledge-based authentication (KBA) answers","items":{"$ref":"#/components/schemas/channelmanager.CardKnowledgeBasedAuthentication"},"minItems":1}},"required":["knowledgeBase"]},"onboarding.Legal":{"type":"object","properties":{"lawSocietyNumber":{"type":"string"}},"required":["lawSocietyNumber"]},"confirmationofpayee.CopPageResponseJsonSrdAccount":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/confirmationofpayee.JsonSrdAccount"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"pispgateway.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"customercompliance.BusinessRequest":{"type":"object","properties":{"type":{"type":"string","description":"Business type","enum":["LLC","PLC","LLP","PARTNERSHIP","SOLETRADER"]},"registeredName":{"type":"string","description":"Registered business name","maxLength":100,"minLength":0},"registrationNumber":{"type":"string","description":"Company registration number","maxLength":40,"minLength":0}},"required":["registeredName","type"]},"pispgateway.StandingOrderSchedule":{"type":"object","description":"The schedule of the standing order","properties":{"frequency":{"type":"string","description":"Type of the capability, can be one of WEEKLY, MONTHLY","enum":["WEEKLY","MONTHLY"]},"initialDate":{"type":"string","description":"The date on which the standing order should begin. This must be at least 3 days in the future from today. Date format 'yyyy-MM-dd'","example":"2021-03-25"},"finalDate":{"type":"string","description":"The optional date on which the standing order should end. If unspecified, the standing order will continue until cancelled.This must be at least 3 days in the future from today. Date format 'yyyy-MM-dd'","example":"2021-03-25"}},"required":["frequency","initialDate"]},"card.SecureCardDetails":{"type":"object","properties":{"pan":{"type":"string","description":"PAN","example":"4567123412341234"},"cvv2":{"type":"string","description":"CVV","example":"123"},"pin":{"type":"string","description":"PIN","example":"1234"}},"required":["cvv2","pan"]},"card.Test":{"allOf":[{"$ref":"#/components/schemas/card.PatchOperation"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/card.JsonNode"}}}],"description":"Test field","required":["op","path","value"]},"rule.CreateRuleRequest":{"type":"object","description":"create rule request","properties":{"type":{"type":"string","description":"The type of Rule. Can be one of the following {SWEEP, SPLIT, FUNDING}"},"name":{"type":"string","description":"Rule's name","example":"My new rule","maxLength":25,"minLength":0},"accountId":{"type":"string","description":"The Account which the Rule is created on.","example":"A1000001","minLength":1},"data":{"$ref":"#/components/schemas/rule.RuleConfigData"}},"required":["accountId","data","name","type"]},"account.delegateId":{"type":"array","description":"List of delegate IDs to retrieve linked customers","items":{"type":"string","description":"Delegate id to retrieve linked customers"}},"payment.approvalStatus":{"type":"array","description":"Payment approval status, multiple statuses can be specified by repeating the parameter","items":{"type":"string","description":"Payment approval status, multiple statuses can be specified by repeating the parameter","enum":["NOTNEEDED","PENDING","APPROVED","REJECTED","DELETED"]}},"customercompliance.BusinessAddressesPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/customercompliance.BusinessAddressResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}}},"directdebit.IndemnityClaimPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/directdebit.IndemnityClaimResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0-based, i.e first page = 0, second page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"account.associateTypes":{"type":"array","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","items":{"type":"string","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","enum":["DIRECTOR","PARTNER","CSECRETARY","SOLETRADER","BENE_OWNER","C_INTEREST","INDIVIDUAL","PCM_INDIVIDUAL","SIGNATORY","TRUST_SETTLOR","TRUST_BENEFICIARY","TRUST_TRUSTEE","PREQUALIFIED"]}},"account.CustomerTrustResponse":{"type":"object","properties":{"trustNature":{"type":"string","enum":["BARE_TRUSTS","INTEREST_IN_POSSESSION_TRUSTS","DISCRETIONARY_TRUSTS","ACCUMULATION_TRUSTS","MIXED_TRUSTS","SETTLOR_INTERESTED_TRUSTS","NON_RESIDENT_TRUSTS","OFFSHORE_TRUSTS","FAMILY_LIVING_TRUST","PILOT_TRUST","VULNERABLE_BENEFICIARY_TRUST","CHARITABLE_TRUSTS","IRREVOCABLE_LIFE_INSURANCE_TRUST","TESTAMENTARY_TRUSTS","OTHER"]}}},"account.UpdateAssociateRequest":{"type":"object","properties":{"type":{"type":"string","description":"Type of associate","minLength":1},"firstName":{"type":"string","description":"Letters, hyphens and apostrophes","maxLength":100,"minLength":1,"pattern":"^[\\p{L}' -]+$"},"middleName":{"type":"string","description":"Letters, hyphens and apostrophes","pattern":"^[\\p{L}' -]*$"},"lastName":{"type":"string","description":"Letters, hyphens and apostrophes","maxLength":100,"minLength":1,"pattern":"^[\\p{L}' -]+$"},"dateOfBirth":{"type":"string","description":"Date in yyyy-MM-dd format. If associate is a non-applicant director or partner, then partial DOB of yyyy-MM format is allowed. Valid age is from 16 to 150 years. If Applicant then minimum age required is 18 years for specific partners. Required for all associate types except PCM_INDIVIDUAL."},"ownership":{"type":"integer","format":"int32","description":"Ownership percentage for Partners","maximum":100,"minimum":1},"homeAddress":{"$ref":"#/components/schemas/account.AddressRequest","description":"Home address"},"id":{"type":"string","description":"ID of associate"},"email":{"type":"string","description":"Contact email address for applicants","maxLength":100,"minLength":0,"pattern":"[^\\s@]+@[^\\s@]+\\.[^\\s@]+"},"phone":{"type":"string","description":"Contact phone number for applicants, will be formatted into international number pattern"}},"required":["firstName","lastName","type"]},"card.AddressDetail":{"type":"object","description":"Address details for the cardholder. Optional for individual customers whose partner has verification type EXTERNAL.","properties":{"addressLine1":{"type":"string","description":"First line of address","example":"Floor 10","maxLength":50,"minLength":1},"addressLine2":{"type":"string","description":"Second line of address","example":"80 George Street","maxLength":50,"minLength":0},"postTown":{"type":"string","description":"Post town","example":"EDINBURGH","maxLength":20,"minLength":1},"postCode":{"type":"string","description":"Postcode","example":"EH2 3BU","maxLength":10,"minLength":1},"country":{"type":"string","description":"Country (ISO 3166 alpha-2 country code)","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","AX","AW","BL","CW","GF","GL","GP","ME","MF","MQ","NC","PF","PM","RE","SX","TF","WF","YT","AI","BM","FK","GB","GG","GI","GS","IO","JE","KY","MS","PN","SH","TC","VG"],"example":"GB","minLength":1}},"required":["addressLine1","country","postCode","postTown"]},"pispgateway.MaximumIndividualVrPayment":{"type":"object","description":"Maximum amount of any single payment initiated using this consent.","properties":{"currency":{"type":"string","description":"Currency of the maximum individual amount. Must be specified in ISO 4217 format."},"amount":{"type":"number","description":"Maximum amount of any single payment initiated using this consent - '1' = 1.00 GBP","example":"100.00"}},"required":["currency"]},"onboarding.CustomerTrustResponse":{"type":"object","properties":{"trustNature":{"type":"string","enum":["BARE_TRUSTS","INTEREST_IN_POSSESSION_TRUSTS","DISCRETIONARY_TRUSTS","ACCUMULATION_TRUSTS","MIXED_TRUSTS","SETTLOR_INTERESTED_TRUSTS","NON_RESIDENT_TRUSTS","OFFSHORE_TRUSTS","FAMILY_LIVING_TRUST","PILOT_TRUST","VULNERABLE_BENEFICIARY_TRUST","CHARITABLE_TRUSTS","IRREVOCABLE_LIFE_INSURANCE_TRUST","TESTAMENTARY_TRUSTS","OTHER"]}}},"onboarding.ConsumerDataResponse":{"type":"object","properties":{"employment":{"type":"string"},"natureOfRelationship":{"type":"string"},"expectedTransactionalActivity":{"$ref":"#/components/schemas/onboarding.ExpectedTransactionalActivityResponse"},"screeningResults":{"$ref":"#/components/schemas/onboarding.ScreeningResultsResponse"},"sourceOfWealth":{"$ref":"#/components/schemas/onboarding.SourceOfWealthResponse"}}},"paymentfileupload.FileUploadRequest":{"type":"object","description":"File upload request body","properties":{"fileName":{"type":"string","description":"Original file name","minLength":1},"content":{"type":"string","description":"The file content must be zipped using gzip format and then Base64 encoded","minLength":1},"submissionType":{"type":"string","description":"BATCH restricts operations to batch level.  BULK (default) allows payment level operations such as approval","enum":["BATCH","BULK"]},"processingDate":{"type":"string","description":"Allows overriding the file processing date"}},"required":["content","fileName"]},"card.ProductDesignDetail":{"type":"object","properties":{"cardRef":{"type":"string","description":"Design reference for card","minLength":1},"packagingRef":{"type":"string","description":"Design reference for card packaging","minLength":1}},"required":["cardRef","packagingRef"]},"card.AppleInAppProvisioningResponse":{"type":"object","description":"AppleInAppProvisioningRequest","properties":{"ephemeralPublicKey":{"type":"string","description":"Ephemeral public key generated to encrypt the data on the provisioning attempt"},"encryptedPassData":{"type":"string","description":"Encrypted payload data requested"},"activationData":{"type":"string","description":"Encrypted OTP for the card provider"}},"required":["activationData","encryptedPassData","ephemeralPublicKey"]},"pispgateway.PaymentContext":{"type":"object","description":"Payment context for the initiation request","properties":{"paymentContextCode":{"type":"string","description":"Indicates type of Payment Context, can be one of BILLPAYMENT, ECOMMERCEGOODS, ECOMMERCESERVICES, OTHER, PARTYTOPARTY. If no value or paymentContext is provided, PARTYTOPARTY is considered the default value.","enum":["BILLPAYMENT","ECOMMERCEGOODS","ECOMMERCESERVICES","OTHER","PARTYTOPARTY"]},"deliveryAddress":{"$ref":"#/components/schemas/pispgateway.DeliveryAddress","description":"Delivery address, must be specified if paymentContextCode is 'ECOMMERCEGOODS'"},"merchant":{"$ref":"#/components/schemas/pispgateway.MerchantDetails","description":"The merchant for the payment context"}},"required":["merchant"]},"cardsimulator.CardActivityRequest":{"type":"object","description":"CardActivityRequest","properties":{"transactionAmount":{"type":"number","description":"The transaction amount","example":"5.45"},"transactionCurrency":{"type":"string","description":"The transaction currency. Defaults to the card's billing currency","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"GBP"},"fxRate":{"type":"number","description":"The foreign exchange rate to use, when transaction currency differs from billing currency. Defaults to 1.0","example":"0.8"},"mcc":{"type":"string","description":"Merchant Category Code","example":"5812"}},"required":["mcc","transactionAmount"]},"card.ShareSecureCardDetailsActivity":{"type":"object","properties":{"action":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"shareMethod":{"type":"string","description":"Method to share secure card details","enum":["RETURN","EMAIL"]}}},"card.GetCardTokensResponse":{"type":"object","properties":{"size":{"type":"integer","format":"int32","description":"Number of elements in content","example":1},"content":{"type":"array","description":"List of response elements","items":{"$ref":"#/components/schemas/card.CardToken"}}},"required":["content","size"]},"onboarding.Construction":{"type":"object","properties":{"turnoverCashPercentage":{"type":"integer","format":"int32","maximum":100,"minimum":0}},"required":["turnoverCashPercentage"]},"onboarding.ConsumerDataRequest":{"type":"object","properties":{"employment":{"type":"string"},"natureOfRelationship":{"type":"string"},"expectedTransactionalActivity":{"$ref":"#/components/schemas/onboarding.ExpectedTransactionalActivityRequest"},"screeningResults":{"$ref":"#/components/schemas/onboarding.ScreeningResultsRequest"},"sourceOfWealth":{"$ref":"#/components/schemas/onboarding.SourceOfWealthRequest"}}},"directdebitoutbound.MandateCancelRequest":{"type":"object","description":"Details of the Mandate Cancel Request","properties":{"mandateId":{"type":"string","description":"Mandate Id","minLength":1},"accountId":{"type":"string","description":"Account Id","minLength":1},"cancellationCode":{"type":"string","description":"Cancellation Code","enum":["REFER_TO_PAYER","INSTRUCTION_CANCELLED_BY_PAYER","PAYER_DECEASED","ACCOUNT_TRANSFERRED","ACCOUNT_CLOSED","ACCOUNT_OR_INSTRUCTION_TRANSFERRED","ADVANCE_NOTICE_DISPUTED","INSTRUCTION_AMENDED","INSTRUCTION_REINSTATED"]},"merchantNumber":{"type":"string","description":"Merchant Number","minLength":1}},"required":["accountId","cancellationCode","mandateId","merchantNumber"]},"card.Move":{"allOf":[{"$ref":"#/components/schemas/card.PatchOperation"},{"type":"object","properties":{"from":{"type":"string","example":"/path/to/originating/field"}}}],"description":"Move field","required":["from","op","path"]},"channelmanager.AuthorisationConstraints":{"type":"object","description":"Authorisation constraints","properties":{"spend":{"type":"array","description":"Spending constraints","items":{"$ref":"#/components/schemas/channelmanager.SpendConstraintDetail"}}}},"card.ShareSecureCardDetailsResponse":{"type":"object","properties":{"id":{"type":"string"},"createdBy":{"type":"string"},"email":{"type":"string"},"status":{"type":"string"},"expiryDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"lastRevealedDate":{"type":"string","format":"date-time"},"noOfAccessesLeft":{"type":"integer","format":"int64"},"maxAccessesAllowed":{"type":"integer","format":"int64"}}},"pispgateway.AspsProviderResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (within Modulr) of the ASPSP","example":"H100000001"},"name":{"type":"string","description":"Name of the ASPSP","example":"Bank of Money"},"capabilities":{"type":"array","description":"Capability list of the ASPSP","items":{"$ref":"#/components/schemas/pispgateway.Capability"}}}},"channelmanager.UpdateCardCustomFieldsRequest":{"type":"object","description":"Custom fields to be updated","properties":{"customFields":{"type":"array","description":"Custom fields","items":{"$ref":"#/components/schemas/channelmanager.CardCustomFieldRequest"},"maxItems":20,"minItems":1}},"required":["customFields"]},"paymentfileupload.FileCreateRequest":{"type":"object","description":"File create payments request body","properties":{"useDuplicate":{"type":"boolean","description":"User confirms to proceed with creating payments on a duplicate file"}}},"onboarding.ExpectedTransactionalActivityRequest":{"type":"object","properties":{"sourceOfFunds":{"type":"string"},"monthlyVolume":{"type":"integer","format":"int32"},"outboundPaymentJurisdictions":{"type":"array","items":{"type":"string","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]}}}},"directdebit.Mandate":{"type":"object","properties":{"id":{"type":"string","description":"Unique id for direct-debit-mandate.","example":"G0000001"},"accountId":{"type":"string","description":"Unique id for account for this mandate.","example":"A0000001"},"reference":{"type":"string","description":"DDI reference that was used during creation."},"externalReference":{"type":"string","description":"External reference that was used during creation (appears on the bank statement)."},"createdDate":{"type":"string","format":"date-time","description":"Datetime when direct-debit-mandate was created.Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000"},"status":{"type":"string","description":"Status of the direct-debit-mandate. mandates must be 'ACTIVE' to make collections. Can be one of ","example":"ACTIVE"},"nextValidCollectionDate":{"type":"string","description":"The earliest date a collection can be created. Format is yyyy-MM-dd.","example":"2018-01-10"},"Name given on Mandate":{"type":"string"},"Address given on Mandate":{"$ref":"#/components/schemas/directdebit.Address"},"sortCode":{"type":"string","description":"Sort Code of the account for which direct-debit-mandate has been created.","example":"123456"},"accountNumber":{"type":"string","description":"Account Number for which direct-debit-mandate has been created.","example":"87654321"},"payeeAccountBid":{"type":"string","description":"Unique id for individual recipient account used for internal transfers","example":"A0000001"},"bulkCreateRequestId":{"type":"string","description":"Id associate to the bulk create request of this mandate.","example":"R210000005"},"bulkCancelRequestId":{"type":"string","description":"Id associate to the bulk cancel request of this mandate.","example":"R210000006"}},"required":["accountId","accountNumber","createdDate","externalReference","id","nextValidCollectionDate","reference","sortCode","status"]},"account.AddressResponse":{"type":"object","description":"Address","properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"postTown":{"type":"string"},"postCode":{"type":"string"},"country":{"type":"string"},"countrySubDivision":{"type":"string"}}},"directdebit.status":{"type":"array","description":"Status of the Mandate","items":{"type":"string","description":"Status of the Mandate","enum":["PENDING","SUBMITTED","ACTIVE","SUSPENDED","REJECTED","CANCELLED","INVALID_REQUEST"]}},"inboundpayment.InboundPaymentRequest":{"type":"object","description":"Details of credit to the account","properties":{"accountId":{"type":"string","description":"The account to be credited","minLength":1},"payerDetail":{"$ref":"#/components/schemas/inboundpayment.PartyDetailRequest","description":"Payer details"},"payeeDetail":{"$ref":"#/components/schemas/inboundpayment.PartyDetailRequest","description":"Payee details"},"description":{"type":"string","description":"Description of the credit","maxLength":255,"minLength":0},"amount":{"type":"number","description":"Amount of the payment in major current Units - '1' = 1.00 GBP","maximum":2147483647,"minimum":0.01},"type":{"type":"string","description":" Type of credit, values: ","enum":["PI_BACS","PI_DD","PI_FAST","PI_SECT","PI_SEPA_INST","PI_SWIFT"],"minLength":1},"transactionDate":{"type":"string","description":"Date of credit in yyyy-MM-ddTHH:mm:ssZ format"},"numberOfTransactions":{"type":"integer","format":"int32","description":"Number of credit transactions to create, defaults to 1","maximum":50,"minimum":1},"schemeInformation":{"$ref":"#/components/schemas/inboundpayment.SchemeInfoRequest","description":"Optional scheme details"}},"required":["accountId","amount","description","payerDetail","type"]},"customercompliance.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"account.StringSearchCriteria":{"type":"object","description":"A list of external references to filter","example":"\"externalReference[0].type\": \"WORD_MATCH\", \"externalReference[0].value\": \"Customer reference\"","properties":{"type":{"type":"string","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","enum":["WORD_MATCH","WORD_MATCH_ALPHANUMERIC","PREFIX","SUFFIX","CONTAINS","EXACT"]},"value":{"type":"string","minLength":1}},"required":["type","value"]},"account.TransactionPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/account.TransactionResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"},"pageStartBalance":{"type":"number","description":"The sum of the transactions up to this page.\nThis is only present if there are no filters other than page and size defined","example":"250.30"}}},"channelmanager.CreateCardRequest":{"type":"object","description":"Card","properties":{"limit":{"type":"number","format":"double","description":"Total card authorisation limit.","example":"1000.00","maximum":99999999.99,"minimum":1},"expiry":{"type":"string","description":"ISO 8601 date with year & month components only. The supplied value must be in the future (cannot be the current month) and is _inclusive_ of the specified month.","example":"2018-12"},"productCode":{"type":"string","description":"Identifies the _type_ of card to create (GBP consumer, GBP business, etc). Modulr will supply a list of possible values."},"externalRef":{"type":"string","description":"Client reference for the newly created card. Maximum of 50 alphanumeric characters (including underscore, hyphen and space).","maxLength":50,"minLength":1,"pattern":"[\\w -]*"},"constraints":{"$ref":"#/components/schemas/channelmanager.Constraints","description":"Constraints"},"authentication":{"$ref":"#/components/schemas/channelmanager.CardAuthentication","description":"Authentication. Required by default, optional for Virtual Business Travel Cards only"},"cancellationDate":{"type":"string","description":"Date for card to be cancelled on","example":"2025-01-01"},"customFields":{"type":"array","description":"Custom fields of card","items":{"$ref":"#/components/schemas/channelmanager.CardCustomFieldRequest"},"maxItems":20,"minItems":0},"authorisationWindow":{"$ref":"#/components/schemas/channelmanager.AuthorisationWindowRequest","description":"Authorisation Windows allow the card holder to add a period of time where the card can ONLY be used, if an Authorisation Window set then transactions outside this window will decline. ISO 8601 date with year, month & day components only."},"frequencyUsage":{"type":"string","enum":["SINGLE_USE","MULTI_USE"]},"holder":{"$ref":"#/components/schemas/channelmanager.CardHolder","description":"CardHolder"}},"required":["expiry","externalRef","limit","productCode"]},"paymentfileupload.FileUploadSummaryContent":{"type":"object","description":"Summary of a single child file upload","properties":{"status":{"type":"string","description":"Status of the child file upload","enum":["NEW","SUBMITTED","PROCESSING","INVALID","VALID","DUPLICATE","REJECTED","ERROR_RETRYABLE","ACCEPTED","PROCESSED","SENDING","PAYMENT_PROCESSING","SPLIT_FILE","PARTIALLY_ACCEPTED"],"example":"ACCEPTED"},"customerName":{"type":"string","description":"Customer name associated with the child file","example":"TestCustomer"},"batchPaymentId":{"type":"string","description":"Batch payment ID, null if not yet processed","example":"D0000001"},"payments":{"type":"array","description":"Aggregated payments grouped by destination account","items":{"$ref":"#/components/schemas/paymentfileupload.PaymentSummary"}}}},"account.Add":{"allOf":[{"$ref":"#/components/schemas/account.PatchOperation"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/account.JsonNode"}}}],"description":"Add field","required":["op","path","value"]},"payment.ids":{"type":"array","items":{"type":"string","description":"Payment IDs. If specified then all other parameters are ignored. Up to 500 IDs can be specified"}},"paymentfileupload.FileUploadSummariesResponse":{"type":"object","description":"Paginated summaries of child file uploads for a delegate payment file","properties":{"fileId":{"type":"string","description":"File ID of the parent upload","example":"F1100001"},"fileName":{"type":"string","description":"File name of the parent upload","example":"file"},"content":{"type":"array","description":"Page content — one entry per child file upload","items":{"$ref":"#/components/schemas/paymentfileupload.FileUploadSummaryContent"}},"size":{"type":"integer","format":"int32","description":"Number of items in this page","example":3},"totalSize":{"type":"integer","format":"int64","description":"Total number of child file uploads","example":3},"page":{"type":"integer","format":"int32","description":"Current page number (0 indexed)","example":0},"totalPages":{"type":"integer","format":"int32","description":"Total number of pages","example":1}}},"card.UpdateCardReportNotificationRequest":{"type":"object","description":"Notification request containing the status of the notification","properties":{"status":{"type":"string","description":"status","minLength":1}},"required":["status"]},"card.CardKnowledgeBasedAuthentication":{"type":"object","properties":{"type":{"type":"string","description":"3DS knowledge-based authentication answer type","enum":["FIRST_PET_NAME","MATERNAL_GRANDMOTHER_MAIDEN_NAME","FAVOURITE_CHILDHOOD_FRIEND","FIRST_CAR","CITY_PARENTS_MET"]},"answer":{"type":"string","description":"3DS knowledge-based authentication answer","maxLength":45,"minLength":1}},"required":["answer","type"]},"cardsimulator.CreateOriginalCreditRequest":{"type":"object","description":"Details of the original credit","properties":{"transactionAmount":{"type":"number"},"transactionCurrency":{"type":"string","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"fxRate":{"type":"number"},"mcc":{"type":"string"}},"required":["fxRate","mcc","transactionAmount","transactionCurrency"]},"payment.BirthDetails":{"type":"object","properties":{"dateOfBirth":{"type":"string","description":"Date of birth in ISO 8601 format of the ultimate payer","example":"1978-01-01","pattern":"^\\d{4}-([0]\\d|1[0-2])-([0-2]\\d|3[01])$"},"cityOfBirth":{"type":"string","description":"City of birth of the ultimate payer","example":"Edinburgh","maxLength":35,"minLength":0},"countryOfBirth":{"type":"string","description":"ISO 3166 country code of the ultimate payers country of birth","example":"GB"}}},"card.CardHolder":{"type":"object","properties":{"title":{"type":"string","description":"Cardholder title is optional for all card types. Maximum of 4 alphanumeric characters.","example":"Mr","pattern":"^[0-9a-zA-Z]{1,4}$"},"firstName":{"type":"string","description":"Cardholder first name. Maximum of 20 alphanumeric characters including space, hyphen and apostrophe. Optional for individual customers whose partner has verification type EXTERNAL and for Virtual Business customers.","example":"Joe","pattern":"^[A-Za-z0-9ÄÖÜäöü/.'^ -]{1,20}$"},"lastName":{"type":"string","description":"Cardholder last name. Maximum of 20 alphanumeric characters including space, hyphen and apostrophe. Optional for individual customers whose partner has verification type EXTERNAL and for Virtual Business customers.","example":"Bloggs","pattern":"^[A-Za-z0-9ÄÖÜäöü/.'^ -]{1,20}$"},"billingAddress":{"$ref":"#/components/schemas/card.AddressDetail","description":"Billing address for the cardholder. Optional for individual customers whose partner has verification type EXTERNAL."},"dateOfBirth":{"type":"string","format":"date","description":"Cardholder date of birth. Must match date format of yyyy-mm-dd. Required for virtual consumer and physical cards. Optional for individual customers.","example":"2001-01-01"},"mobileNumber":{"type":"string","description":"Cardholder mobile number. Must start with a '+', followed by the country code and then the mobile number. Required for virtual consumer and physical cards.","example":"+447123456000"},"email":{"type":"string","format":"email","description":"Cardholder email","example":"cardholder@example.com","maxLength":50,"minLength":0}},"required":["firstName","lastName"]},"card.CreateCardRequest":{"type":"object","description":"Card","properties":{"limit":{"type":"number","format":"double","description":"Total card authorisation limit.","example":"1000.00","maximum":99999999.99,"minimum":1},"expiry":{"type":"string","description":"ISO 8601 date with year & month components only. The supplied value must be in the future (cannot be the current month) and is _inclusive_ of the specified month.","example":"2018-12"},"productCode":{"type":"string","description":"Identifies the _type_ of card to create (GBP consumer, GBP business, etc). Modulr will supply a list of possible values."},"externalRef":{"type":"string","description":"Client reference for the newly created card. Maximum of 50 alphanumeric characters (including underscore, hyphen and space).","maxLength":50,"minLength":1,"pattern":"[\\w -]*"},"constraints":{"$ref":"#/components/schemas/card.Constraints","description":"Constraints"},"authentication":{"$ref":"#/components/schemas/card.CardAuthentication","description":"Authentication. Required by default, optional for Virtual Business Travel Cards only"},"cancellationDate":{"type":"string","description":"Date for card to be cancelled on","example":"2025-01-01"},"customFields":{"type":"array","description":"Custom fields of card","items":{"$ref":"#/components/schemas/card.CardCustomFieldRequest"},"maxItems":20,"minItems":0},"authorisationWindow":{"$ref":"#/components/schemas/card.AuthorisationWindowRequest","description":"Authorisation Windows allow the card holder to add a period of time where the card can ONLY be used, if an Authorisation Window set then transactions outside this window will decline. ISO 8601 date with year, month & day components only."},"frequencyUsage":{"type":"string","enum":["SINGLE_USE","MULTI_USE"]},"holder":{"$ref":"#/components/schemas/card.CardHolder","description":"CardHolder"}},"required":["expiry","externalRef","limit","productCode"]},"channelmanager.Replace":{"allOf":[{"$ref":"#/components/schemas/channelmanager.PatchOperation"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/channelmanager.JsonNode"}}}],"description":"Replace field","required":["op","path","value"]},"customercompliance.AssociatePageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/customercompliance.AssociateResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}}},"inboundpayment.Address":{"type":"object","properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"postTown":{"type":"string"},"postCode":{"type":"string"},"country":{"type":"string"}}},"account.BusinessDataResponse":{"type":"object","properties":{"natureOfRelationship":{"type":"string"},"expectedTransactionalActivity":{"$ref":"#/components/schemas/account.ExpectedTransactionalActivityResponse"},"screeningResults":{"$ref":"#/components/schemas/account.ScreeningResultsResponse"},"sourceOfWealth":{"$ref":"#/components/schemas/account.SourceOfWealthResponse"}}},"directdebit.ReconciliationPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/directdebit.ReconciliationResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0-based, i.e first page = 0, second page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"confirmationofpayee.JsonOutboundCopErrorResponse":{"type":"object","description":"Account Name Check Error Response","properties":{"id":{"type":"string"},"field":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"},"errorCode":{"type":"string"}},"required":["code","message"]},"card.UpdateShareSecureDetailsRequest":{"type":"object","description":"Share secure card details request","properties":{"noOfLinkAccesses":{"type":"integer","format":"int64","description":"Number of times token/link shared will be accessible. Cannot be smaller than existing number of accesses"},"expiryDate":{"type":"string","format":"date","description":"Date of expiry of the secure card details link.Must match date format of yyyy-mm-dd and be in the future.","example":"2026-01-01"},"otherDetailsToShare":{"type":"array","description":"List of other card details to share. Will be validated against fields in card response. Will replace existing list","items":{"type":"string"}}}},"card.DownloadReportResponse":{"type":"object","properties":{"preSignedUrl":{"type":"string"}}},"payment.BatchPayment":{"type":"object","properties":{"id":{"type":"string","description":"Unique id for the Batch Payment. 10 characters long","example":"D920000001"},"externalReference":{"type":"string","description":"External reference, if provided","example":"aReference_00001"},"status":{"type":"string","description":"Current status of batch.","enum":["ACCEPTED","REJECTED","SUBMITTED","CANCELLED"],"example":"ACCEPTED"},"totalPayments":{"type":"integer","format":"int32","description":"Total count of payments in this batch","example":9123},"currentUserCanApprove":{"type":"boolean","description":"Whether the user is allowed to approve this batch, based on their approval limits, and applicable configuration","example":true},"paymentDetails":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/payment.PaymentsSummary"},"description":"Summary of payments and approvals, per currency (as a 3-alpha currency code)"},"approvals":{"type":"array","description":"List of batch-level approvals","items":{"$ref":"#/components/schemas/payment.PaymentApproval"}},"currentUserCanCancel":{"type":"boolean","description":"Whether the user is allowed and currently able to cancel at least one of the payments in this batch"},"createdDate":{"type":"string","format":"date-time","description":"Datetime when the batch payment was created. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000"},"createdBy":{"type":"string","description":"ID of the user that created the payment"},"processingDateFrom":{"type":"string","format":"date","description":"Earliest processing date in the batch file or the batch creation date if the file does not have any dates. Date format 'yyyy-MM-dd'","example":"2017-01-28"},"processingDateTo":{"type":"string","format":"date","description":"Last processing date in the batch file or empty if the file does not have any dates. Date format 'Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000'","example":"2017-01-28"},"earliestScheduledPaymentDate":{"type":"string","format":"date","description":"Earliest processing date in the batch file or empty if the file does not have any dates. Date format 'Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000'","example":"2017-01-28"},"requiredApprovalCount":{"type":"integer","format":"int32","description":"The number of required approvals for the batch.  Applicable to batch payments of submissionType BATCH"},"batchSummary":{"$ref":"#/components/schemas/payment.BatchSummary","description":"Summary of the state of payment requests in this batch"},"strict":{"type":"boolean","description":"Strict processing flag. Whether the entire batch should fail on any individual payment validation failure"}}},"card.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"card.NotificationRequest":{"type":"object","description":"Notification request containing the emails to send the report to","properties":{"emails":{"type":"array","items":{"type":"string"}}}},"card.CreateShareSecureCardDetailsResponse":{"type":"object","description":"Response for creating a share secure card details link.","properties":{"link":{"type":"string","description":"Link to secure card details. Only returned for method RETURN"},"passcode":{"type":"string","description":"passcode to view the secured card details. Only returned for method RETURN"}}},"channelmanager.Remove":{"allOf":[{"$ref":"#/components/schemas/channelmanager.PatchOperation"}],"description":"Remove field","required":["op","path"]},"payment.OfficialIdDetails":{"type":"object","properties":{"drivingLicenceNumber":{"type":"string","description":"Driving licence number","example":"JONES849339TS8AD","maxLength":35,"minLength":0},"customerNumber":{"type":"string","description":"Customer number","example":"23547326547632","maxLength":35,"minLength":0},"socialSecurityNumber":{"type":"string","description":"Social security number or equivalent","example":"1110000000022AB","maxLength":35,"minLength":0},"passportNumber":{"type":"string","description":"Passport number","example":"123456789","maxLength":35,"minLength":0},"idCardNumber":{"type":"string","description":"National ID card number","example":"123456789","maxLength":35,"minLength":0},"otherIdNumber":{"type":"string","description":"Other ID number","example":"123456789","maxLength":35,"minLength":0}}},"cardsimulator.CardSettlementRequest":{"type":"object","description":"Optional settlement details. Omit body for full settlement.","properties":{"transactionAmount":{"type":"number","description":"The transaction amount","example":"5.45"},"transactionCurrency":{"type":"string","description":"The transaction currency","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"GBP"},"fxRate":{"type":"number","description":"The foreign exchange rate","example":"0.8"},"mcc":{"type":"string","description":"Merchant Category Code","example":"5812"}},"required":["fxRate","mcc","transactionAmount","transactionCurrency"]},"card.Replace":{"allOf":[{"$ref":"#/components/schemas/card.PatchOperation"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/card.JsonNode"}}}],"description":"Replace field","required":["op","path","value"]},"card.CardToken":{"type":"object","description":"Payment token details for a card","properties":{"id":{"type":"string","description":"Card token ID","example":"T110000001"},"expiry":{"type":"string","format":"date","description":"Token expiry date (ISO 8601 format)","example":"2021-10-31"},"type":{"type":"string","description":"Type of system the token is encoded onto","enum":["BROWSER_ACCESSIBLE_WALLET","CONTACTLESS_DEVICE_PAN","CARD_ON_FILE_PAN","REAL_PAN","UNKNOWN","VIRTUAL_PAN","SECURE_ELEMENT","CLOUD_BASED"],"example":"SECURE_ELEMENT"},"wallet":{"type":"string","description":"Wallet the token belongs to","enum":["APPLE","GOOGLE","MRCHTOKEN"],"example":"APPLE"},"status":{"type":"string","description":"Card token status","enum":["APPROVED","ACTIVE","AWAITING_AUTHENTICATION","AUTHENTICATION_FAILED","AUTO_SUSPENDED","SUSPENDED","DEACTIVATED","UNKNOWN"],"example":"PROVISIONED"},"language":{"type":"string","description":"2-digit ISO 639-1 language code","example":"EN"},"devices":{"type":"array","items":{"$ref":"#/components/schemas/card.CardTokenDevice"}},"maskedDpan":{"type":"string","description":"Masked DPAN (last 4 digits) to the associated token ID","example":"1234"}},"required":["expiry","id","language","status","type","wallet"]},"onboarding.AddressResponse":{"type":"object","description":"Address","properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"postTown":{"type":"string"},"postCode":{"type":"string"},"country":{"type":"string"},"countrySubDivision":{"type":"string"}},"required":["addressLine1","country","postCode","postTown"]},"rule.ConditionalSplitConfig":{"type":"object","description":"Configuration for a Conditional Split Rule","properties":{"destinationId":{"type":"string","description":"Id of destination beneficiary. e.g. B1000001."},"percent":{"type":"string","description":"Percentage of payment to be moved to specified destination. e.g. 7.25.","minLength":1},"conditionAmount":{"type":"number","description":"Amount the conditional split rule should reach before defaulting to the split rule. e.g. 100.","maximum":2147483647,"minimum":0.01},"conditionDone":{"type":"boolean","description":"Whether the condition amount has been met. e.g. true or false"}},"required":["conditionAmount","destinationId","percent"]},"inboundpayment.PartyDetailRequest":{"type":"object","properties":{"name":{"type":"string","description":"Party name"},"identifier":{"$ref":"#/components/schemas/inboundpayment.AccountIdentifierDetailRequest","description":"Account identifier"},"address":{"$ref":"#/components/schemas/inboundpayment.Address","description":"Party address"}},"required":["identifier","name"]},"account.ExpectedTransactionalActivityResponse":{"type":"object","properties":{"sourceOfFunds":{"type":"string"},"monthlyVolume":{"type":"integer","format":"int32"},"outboundPaymentJurisdictions":{"type":"array","items":{"type":"string","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]}}}},"pispgateway.Destination":{"type":"object","description":"The destination account for the payment","properties":{"type":{"type":"string","description":"Indicates the type of destination. Can be one of ACCOUNT, SCAN","enum":["ACCOUNT","SCAN"]},"id":{"type":"string","description":"Identifier of the destination account if using ACCOUNT type","example":"A1100001"},"accountNumber":{"type":"string","description":"Account Number of destination account if using SCAN type","example":"12345678","pattern":"^[0-9]{8}$"},"sortCode":{"type":"string","description":"Sort Code of destination account if using SCAN type","example":"000000","pattern":"^[0-9]{6}$"},"name":{"type":"string","description":"Name of destination account if using SCAN type (this may be truncated)","example":"Test","maxLength":70,"minLength":0}},"required":["type"]},"onboarding.DocumentInfo":{"type":"object","properties":{"path":{"type":"string","minLength":1},"fileName":{"type":"string","minLength":1},"uploadedDate":{"type":"string","description":"Valid date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000","minLength":1}},"required":["fileName","path","uploadedDate"]},"channelmanager.CardKnowledgeBasedAuthentication":{"type":"object","properties":{"type":{"type":"string","description":"3DS knowledge-based authentication answer type","enum":["FIRST_PET_NAME","MATERNAL_GRANDMOTHER_MAIDEN_NAME","FAVOURITE_CHILDHOOD_FRIEND","FIRST_CAR","CITY_PARENTS_MET"]},"answer":{"type":"string","description":"3DS knowledge-based authentication answer","maxLength":45,"minLength":1}},"required":["answer","type"]},"customercompliance.CreateAssociateRequest":{"type":"object","properties":{"firstName":{"type":"string","description":"Associate first name","minLength":1},"middleName":{"type":"string","description":"Associate middle name"},"lastName":{"type":"string","description":"Associate last name","minLength":1},"dateOfBirth":{"type":"string","description":"Associate date of birth in YYYY-MM-DD format","minLength":1,"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"address":{"$ref":"#/components/schemas/customercompliance.AddressRequest","description":"Primary address for the associate"},"types":{"type":"array","description":"Associate type","items":{"type":"string","description":"Associate type","enum":["INDIVIDUAL","DIRECTOR","PARTNER","BENE_OWNER","SOLETRADER","AUTHORISED_SIGNER"]},"minItems":1},"contactDetails":{"$ref":"#/components/schemas/customercompliance.ContactDetailsRequest","description":"Contact details for the associate"},"ownershipPercentage":{"type":"number","description":"Ownership percentage","maximum":100,"minimum":0}},"required":["address","contactDetails","dateOfBirth","firstName","lastName","types"]},"channelmanager.CardReplacementRequest":{"type":"object","description":"Replacement","properties":{"reason":{"type":"string","description":"The reason for replacing the card. Can be one of DAMAGED (physical only), LOST, STOLEN, RENEW","enum":["STOLEN","DAMAGED","LOST","RENEW"],"example":"STOLEN"},"externalRef":{"type":"string","description":"Client reference for the newly created card. Maximum of 50 alphanumeric characters (including underscore, hyphen and space).","maxLength":50,"minLength":1,"pattern":"[\\w-\\s]*"},"design":{"$ref":"#/components/schemas/channelmanager.ProductDesignDetail","description":"Design references for physical card and packaging"},"expiry":{"type":"string","description":"ISO 8601 date with year & month components only. The supplied value must be in the future (cannot be the current month) and is _inclusive_ of the specified month. If no expiry is selected, the standard product expiry date will be set","example":"2026-12"},"shippingAddress":{"$ref":"#/components/schemas/channelmanager.AddressDetail","description":"Shipping address details for card. Optional for individual customers whose partner has verification type EXTERNAL"}},"required":["reason"]},"pispgateway.PaymentInitiationResponse":{"type":"object","description":"Response object for Get Payment Initiation","properties":{"id":{"type":"string","description":"The identifier of the payment initiation","example":"I000000001"},"status":{"type":"string","description":"The status of the payment initiation, can be one of SUBMITTED, AWAITING_CONSENT, CONSENT_REJECTED, EXECUTED, ER_EXPIRED, ER_EXTSYS, ER_GENERAL","example":"AWAITING_CONSENT"},"paymentAmount":{"$ref":"#/components/schemas/pispgateway.PaymentAmount","description":"The payment amount"},"paymentReference":{"type":"string","description":"The payment reference"},"destination":{"$ref":"#/components/schemas/pispgateway.Destination","description":"The payment destination"},"aspspId":{"type":"string","description":"The identifier of the ASPSP used for the payment","example":"H100000001"},"aspspPaymentStatus":{"type":"string","description":"The status of the payment at the ASPSP. When available, this is passed through from the ASPSP without modification.","example":"AcceptedSettlementCompleted"}}},"channelmanager.Constraints":{"type":"object","properties":{"authorisation":{"$ref":"#/components/schemas/channelmanager.AuthorisationConstraints","description":"Authorisation constraints"}}},"payment.BatchPaymentOutRequest":{"type":"object","description":"Details of Batch request","properties":{"externalReference":{"type":"string","description":"Your reference for this Batch of payments","example":"aReference_00001","maxLength":50,"minLength":0,"pattern":"[\\w-\\s]*"},"strictProcessing":{"type":"boolean","description":"Flag to control if the entire batch fails for any individual payment validation failure"},"submissionType":{"type":"string","description":"BATCH restricts operations to batch level.  BULK (default) allows payment level operations such as approval","enum":["BATCH","BULK"]},"payments":{"type":"array","description":"List of payments.","items":{"$ref":"#/components/schemas/payment.PaymentOutRequest"},"maxItems":10000,"minItems":1}},"required":["payments"]},"account.TransactionResponse":{"type":"object","description":"Transaction","properties":{"id":{"type":"string","description":"Unique id for the Transaction","example":"T000000001"},"amount":{"type":"number","description":"Amount of the transaction in Major Currency Units"},"currency":{"type":"string","description":"Currency of the account in ISO 4217 format","example":"GBP"},"description":{"type":"string","description":"Description of the transaction. Contains Payer/ Payee details and reference"},"transactionDate":{"type":"string","format":"date-time","description":"Datetime when the transaction took place. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000"},"postedDate":{"type":"string","format":"date-time","description":"Datetime when the transaction was posted to the Modulr system. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000"},"credit":{"type":"boolean","description":"Indicates if the transaction was a Credit or a Debit"},"type":{"type":"string","description":"Enumerated type indicating the type of the transaction"},"sourceId":{"type":"string"},"sourceExternalReference":{"type":"string"},"additionalInfo":{"description":"any extra information available on transaction."},"account":{"$ref":"#/components/schemas/account.AccountResponse","description":"Account information"}}},"paymentfileupload.PaymentSummary":{"type":"object","description":"Aggregated payment count per destination account","properties":{"sortCode":{"type":"string","description":"Destination account sort code","example":"111111"},"accountNumber":{"type":"string","description":"Destination account number","example":"11111111"},"numberOfPayments":{"type":"integer","format":"int32","description":"Number of payments to this account","example":3}}},"card.OneTimeTokenRequest":{"type":"object","properties":{"publicKey":{"type":"string","description":"Base64 UTF-8 encoded RSA public key to be used to encrypt the token in the response. The key must be at least 4096 bits in length."},"purpose":{"type":"string","default":"READ","description":"What the token will be used for. UPDATE tokens cannot be used for READ purposes, and READ tokens cannot be used for updates.","enum":["READ","UPDATE"]}}},"integrationnotification.WebhookFailureResponse":{"type":"object","properties":{"id":{"type":"string","description":"Notification bid for which the webhook delivery failed"},"failureDateTime":{"type":"string","format":"date-time","description":"Failure time. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g '2017-01-28T01:01:01+0000'"},"data":{"description":"Payload data that was attempted to be sent to the webhook URL"}},"required":["data","failureDateTime","id"]},"directdebit.CreateCollectionScheduleRequest":{"type":"object","description":"Details of collection to create.","properties":{"frequency":{"type":"string","description":"Frequency for direct-debit collection. Can be one of: ONCE, WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY.","enum":["ONCE","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY","WEEKLY","EVERY_TWO_WEEKS","EVERY_FOUR_WEEKS"],"minLength":1},"numberOfPayments":{"type":"integer","format":"int32","description":"Number of payments for direct-debit collection, must be '1' where frequency is 'ONCE'.","minimum":1},"firstPaymentAmount":{"type":"number","description":"Amount of the first collection payment.<br>\nNote: your item limit is set during onboarding will be lower than field maximum and Bacs scheme item limit of £20m.","example":"100.00","maximum":20000000,"minimum":0.01},"firstPaymentDate":{"type":"string","description":"Date of the first collection payment, format must be: yyyy-MM-dd","example":"2018-01-10"},"regularPaymentAmount":{"type":"number","description":"Amount of the regular collection payments following first collection amount. Does not apply where the frequency is 'ONCE'.<br>\nNote: your item limit is set during onboarding will be lower than field maximum and Bacs scheme item limit of £20m","example":"100.00","maximum":20000000,"minimum":0.01},"regularPaymentStartDate":{"type":"string","description":"Start date of the regular collection payment, format: yyyy-MM-dd<br> Note: Does not apply where the frequency is 'ONCE'.","example":"2018-01-10"},"currency":{"type":"string","description":"Currency in which payment should be made. Must be 'GBP' currently.","minLength":1},"externalReference":{"type":"string","description":"External Reference for collection schedule, should contain only alphanumeric characters, underscore, hyphen and space.<br> For your internal reconciliation only, not sent to Bacs scheme.","example":"REFERENCE - 12","maxLength":50,"minLength":0,"pattern":"[\\w-\\s]*"},"collectionReference":{"type":"string","description":"An optional additional collection specific reference to be appended to the reference of the mandate.<br>\nThis is concatenated after the  core reference of the mandate, and will be truncated if combined reference is >18 characters.<br>\nShould only contain alphanumeric characters, dot, ampersand, forward-slash and hyphen only.","example":"ABCD - EFGH","maxLength":12,"minLength":0,"pattern":"[\\w-\\s]*"},"collectionCorrelationName":{"type":"string","description":"(If enabled by Modulr) an optional collection specific reference appended to abbreviated SU name for the given collection schedule. If feature not enabled, any parameter supplied will be ignored.<br>\nWhen is enabled, this value is concatenated to a Service User Name abbreviation (set by Modulr) to form a Service User name containing extra information that can be used by payer to correlate (identify) transaction easily.<br>\nCharacters restricted to: alphanumeric characters, numbers, space, dot, ampersand, forward-slash and hyphen only.","example":"TEST/NAME-1.2","maxLength":18,"minLength":0,"pattern":"^[a-zA-Z 0-9\\.\\&\\/-]+$"}},"required":["currency","frequency","numberOfPayments"]},"card.ReportTypeNotificationPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/card.ReportTypeNotificationResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"notification.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"onboarding.Charity":{"type":"object","properties":{"onCharitiesCommission":{"type":"boolean"},"charityNumber":{"type":"string"}},"required":["onCharitiesCommission"]},"onboarding.ScreeningResultsResponse":{"type":"object","properties":{"adverseMedia":{"type":"array","items":{"type":"string"}},"peps":{"type":"array","items":{"type":"string"}},"sanctions":{"type":"array","items":{"type":"string"}}}},"payment.PaymentDetails":{"type":"object","properties":{"amount":{"type":"number","description":"Amount of currency that the payment is in","example":"1000.45"},"exchangeRate":{"type":"number","description":"Exchange rate","example":"1.45"},"currency":{"type":"string","description":"ISO 4217 currency code that the amount is in","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]}},"required":["amount","currency","exchangeRate"]},"channelmanager.CardActivityPageResponse":{"type":"object","properties":{"content":{"type":"array","description":"List of responses on the current page","items":{"$ref":"#/components/schemas/channelmanager.CardActivityResponse"}},"size":{"type":"integer","format":"int32","description":"Page size"},"totalSize":{"type":"integer","format":"int64","description":"Total count"},"page":{"type":"integer","format":"int32","description":"Current page number, 0 based; i.e first-page = 0, second-page = 1"},"totalPages":{"type":"integer","format":"int32","description":"Total pages"}},"required":["content","page","size","totalPages","totalSize"]},"notification.WebHookFailureResponse":{"type":"object","properties":{"url":{"type":"string","description":"Endpoint URL for receiving webhook data"},"eventName":{"type":"string","description":"Event which would trigger the webhook","enum":["PAYIN","PAYOUT","BALANCE_LOW","BALANCE_HIGH","BALANCE","DDMANDATE","CUSTVSTAT","ACCOUNT_STATEMENT","PENDING_PAYMENTS","DD_INCOMING_DEBIT","DD_FAILED_CLAIM","DD_FUNDS_RETURNED","CARD_AUTH","CARD_AUTH_OFFLINE","CARD_CREATION","UPCOMING_CREDIT","UPCOMING_COLLECTION_CREDIT","UPCOMING_COLLECTION_DEBIT","CARD_STATUS_UPDATE","CARD_TOKEN_PROVISIONING","PAYMENT_COMPLIANCE_STATUS","DD_COLLECTION_STATUS","ACCOUNT_SWITCH_UPDATE","PAYMENT_FILE_UPLOAD","ACCOUNT_STATUS_CHANGE","PAYMENT_APPROVAL_STATUS_CHANGE","CUSTOMER_BATCH_PAYMENT_APPROVAL_STATUS_CHANGE","CARD_BULK_OPS_COMPLETED","CUSTOMER_STATUS","CREDIT_AUTH","DD_INDEMNITY_CLAIM_STATUS","APPLICATION_STATUS_CHANGE","CUSTOMER_CREATED"]},"customerBid":{"type":"string","description":"Unique Identifier for the customer of this webhook."},"retry":{"type":"boolean","description":"Turn webhook retry mechanism on/off"},"lastFailedTime":{"type":"string","format":"date-time","description":"Last failure time. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g '2017-01-28T01:01:01+0000'"},"data":{}},"required":["customerBid","eventName","lastFailedTime","retry","url"]},"payment.POODetails":{"type":"object","properties":{"ultimatePayer":{"$ref":"#/components/schemas/payment.UltimatePayer"},"originalPaymentDetails":{"$ref":"#/components/schemas/payment.PaymentDetails"},"chargeDetails":{"$ref":"#/components/schemas/payment.Charge"},"additionalRemittanceInformation":{"type":"string","maxLength":140,"minLength":0}}},"paymentfileupload.FilesCreatePaymentsResponse":{"type":"object","description":"Response containing payment creation results for multiple files","properties":{"results":{"type":"array","description":"Results for each file processed","items":{"$ref":"#/components/schemas/paymentfileupload.FileCreatePaymentsResult"}}}},"card.CardReplacementResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card identifier. Maximum of 10 alphanumeric characters."},"cvv2":{"type":"string","description":"Card CVV2 number."},"pan":{"type":"string","description":"Full card PAN."},"createdDate":{"type":"string","format":"date-time","description":"The creation date of the card","example":"2019-01-29T11:01:54.826+0000"},"externalRef":{"type":"string","description":"Client reference for the newly created card."},"expiry":{"type":"string","description":"An ISO 8601 date with year & month components only","example":"2018-12"},"maxLimit":{"type":"string","description":"Maximum limit which can be set on this card and is the maximum lifetime spend the card can have","example":"4000.00"},"managementToken":{"type":"string","description":"Card Management Token required for API users for additional security when managing sensitive card data"}},"required":["createdDate","cvv2","expiry","externalRef","id","maxLimit","pan"]},"onboarding.CustomerTaxProfileRequest":{"type":"object","properties":{"taxIdentifier":{"type":"string","description":"Tax identifier for customers of type SOLETRADER. Optional for type SOLETRADER, not to be set for non-SOLETRADER customers.","maxLength":15,"minLength":0}},"required":["taxIdentifier"]},"onboarding.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"account.qualifier":{"type":"array","description":"A list of external qualifiers","items":{"type":"string","description":"A list of external qualifiers"}},"customercompliance.CreateBusinessAddressResponse":{"type":"object","properties":{"id":{"type":"string","description":"Business address ID"}}},"pispgateway.CreateVrpConsentInitiationResponse":{"type":"object","description":"Response object to Initiate Vrp Consent","properties":{"vrpConsentInitiationId":{"type":"string","description":"The unique identifier of the VRP consent initiation request at Modulr","example":"E210000004"},"redirectUrl":{"type":"string","description":"A redirect URL for the user to authorise the payment initiation request at the ASPSP","example":"https://www.bankofmoney.com/authorize"}}},"onboarding.DelegateResponse":{"type":"object","description":"Delegate","properties":{"id":{"type":"string","description":"Unique reference for the Delegate.","example":"D0000001"},"name":{"type":"string","description":"Name for the Delegate"},"address":{"$ref":"#/components/schemas/onboarding.AddressResponse","description":"Address of the Delegate"},"roleId":{"type":"string","description":"The id of the Role assigned to the delegate","example":"R02002M5"},"externalReference":{"type":"string","description":"External system reference for the Delegate"},"partner":{"type":"string","description":"Partner Bid.","example":"R0000001"},"status":{"type":"string","description":"Status of the Delegate."},"created":{"type":"string","format":"date-time","description":"Datetime the Delegate was created.Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000"},"updated":{"type":"string","format":"date-time","description":"Datetime the Delegate was last updated.Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000"}},"required":["created","id","name","roleId","status","updated"]},"directdebit.CreateMandateRequest":{"type":"object","description":"Details of the Direct Debit mandate.","properties":{"name":{"type":"string","description":"Name for mandate","maxLength":40,"minLength":0},"reference":{"type":"string","description":"Mandate reference, should contain only letters, numbers, space, dot, ampersand, forward-slash , hyphen","example":"REFER-1.2","maxLength":18,"minLength":6,"pattern":"^[a-zA-Z 0-9\\.\\&\\/-]+$"},"externalReference":{"type":"string","description":"External reference for mandate","maxLength":50,"minLength":0,"pattern":"[\\w-\\s]*"},"accountName":{"type":"string","description":"Payee's account name","maxLength":100,"minLength":1},"sortCode":{"type":"string","description":"Payee's sort code of account for which direct-debit-mandate has to be created.","example":"000000","pattern":"\\p{Digit}{6}"},"accountNumber":{"type":"string","description":"Payee's account number for which direct-debit-mandate has to be created.","example":"12345678","pattern":"\\p{Digit}{8}"},"address":{"$ref":"#/components/schemas/directdebit.Address","description":"Payee's address"},"phone":{"type":"string","description":"Payee's phone number","maxLength":14,"minLength":0,"pattern":"\\p{Digit}+"},"email":{"type":"string","description":"Payee's email address","maxLength":100,"minLength":0,"pattern":"[^\\s@]+@[^\\s@]+\\.[^\\s@]+"},"payeeAccountBid":{"type":"string","description":"Payee's accountBid"}},"required":["accountName","accountNumber","address","externalReference","name","phone","reference","sortCode"]},"channelmanager.CardReplacementResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card identifier. Maximum of 10 alphanumeric characters."},"cvv2":{"type":"string","description":"Card CVV2 number."},"pan":{"type":"string","description":"Full card PAN."},"createdDate":{"type":"string","format":"date-time","description":"The creation date of the card","example":"2019-01-29T11:01:54.826+0000"},"externalRef":{"type":"string","description":"Client reference for the newly created card."},"expiry":{"type":"string","description":"An ISO 8601 date with year & month components only","example":"2018-12"},"maxLimit":{"type":"string","description":"Maximum limit which can be set on this card and is the maximum lifetime spend the card can have","example":"4000.00"},"managementToken":{"type":"string","description":"Card Management Token required for API users for additional security when managing sensitive card data"}},"required":["createdDate","cvv2","expiry","externalRef","id","maxLimit","pan"]},"onboarding.BrandNameResponse":{"type":"object","description":"BrandName","properties":{"id":{"type":"string","description":"Unique id for the Brand Name"},"name":{"type":"string","description":"The Brand Name"}},"required":["id","name"]},"payment.PaymentResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique id for the Payment request. 10 characters long","example":"P000001ABC"},"status":{"type":"string","description":"Current status of payment.","enum":["SUBMITTED","SCREENING_REQ","VALIDATED","PENDING_FOR_DATE","PENDING_FOR_FUNDS","EXT_PROC","PROCESSED","RECONCILED","ER_INVALID","ER_EXTCONN","ER_EXTSYS","ER_EXPIRED","ER_GENERAL","ER_BATCH","EXT_SENT","UNALLOCATED","HELD","RETURNED","CANCELLED","REPROCESSING","VOID","CLEARING","HELD_IN_SUSPENSE"]},"createdDate":{"type":"string","format":"date-time","description":"Datetime the request was created. Format is 'yyyy-MM-dd'T'HH:mm:ss.sssZ' where Z is UTC offset. e.g '2017-01-28T01:01:01.010+0000'","example":"2017-01-28T01:01:01.010+0000"},"externalReference":{"type":"string","description":"external reference if provided","example":"aReference_00001"},"details":{"description":"All the details of the payment from the original request"},"approvalStatus":{"type":"string","description":"Current approval status of payment","enum":["NOTNEEDED","PENDING","APPROVED","REJECTED","DELETED"]},"message":{"type":"string","description":"Information about payment (if available)"},"schemeInfo":{"$ref":"#/components/schemas/payment.SchemeInfo","description":"Information with regards to the payment scheme"},"createdBy":{"type":"string","description":"ID of the user that created the payment"},"type":{"type":"string","enum":["PAYIN","PAYOUT","RETURN"]},"paymentScheduledDate":{"type":"string","format":"date-time","description":"Datetime of the payment scheduled at. Format is 'yyyy-MM-dd'T'HH:mm:ss.sssZ' where Z is UTC offset. e.g '2017-01-28T01:01:01.010+0000'","example":"2017-01-28T01:01:01.010+0000"},"currentUserCanApprove":{"type":"boolean","description":"Indicates if current user can approve the payment"},"approvals":{"type":"array","description":"List of approvals performed on the payment","items":{"$ref":"#/components/schemas/payment.PaymentApproval"}}},"required":["details","externalReference","id","status"]},"cardsimulator.CardAuthorisationResponse":{"type":"object","description":"CardAuthorisationResponse","properties":{"authorisationId":{"type":"string","description":"Authorisation Id","example":"A00000000X"},"cardId":{"type":"string","description":"Card Id","example":"V000000001"},"status":{"type":"string","description":"Authorisation Status [APPROVED, REVERSED, SETTLED]","enum":["APPROVED","REVERSED","SETTLED"],"example":"APPROVED"},"transactionAmount":{"type":"number","description":"Authorisation Transaction Amount","example":100},"transactionCurrency":{"type":"string","description":"Currency for this transaction","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"EUR"},"billingAmount":{"type":"number","description":"Authorisation billing amount","example":80},"billingCurrency":{"type":"string","description":"Currency of the card","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"example":"GBP"},"fxRate":{"type":"number","description":"Foreign exchange rate used between transaction and billing currencies","example":"0.8"},"mcc":{"type":"string","description":"Merchant Category Code","example":"5812"}},"required":["authorisationId","billingAmount","billingCurrency","cardId","fxRate","mcc","status","transactionAmount","transactionCurrency"]},"document.CustomerDocumentUploadRequest":{"type":"object","properties":{"fileName":{"type":"string","maxLength":100,"minLength":0,"pattern":"^[\\w\\s-.]+\\.(\\w){3,4}$"},"content":{"type":"string","description":"Needs to be Base64 encoded","minLength":1},"type":{"type":"string","description":"Document type uploaded for customer","enum":["ID_DOCUMENT","PROOF_OF_ADDRESS","BUSINESS_DOCUMENTATION"]}},"required":["content","fileName","type"]},"account.BusinessDataRequest":{"type":"object","properties":{"natureOfRelationship":{"type":"string"},"expectedTransactionalActivity":{"$ref":"#/components/schemas/account.ExpectedTransactionalActivityRequest"},"screeningResults":{"$ref":"#/components/schemas/account.ScreeningResultsRequest"},"sourceOfWealth":{"$ref":"#/components/schemas/account.SourceOfWealthRequest"}}},"account.customerId":{"type":"array","description":"The customer ID for getting account by customer ID","example":"C1234567","items":{"type":"string","description":"The customer ID for getting account by customer ID","example":"C1234567"}},"card.CardReplacementRequest":{"type":"object","description":"Replacement","properties":{"reason":{"type":"string","description":"The reason for replacing the card. Can be one of DAMAGED (physical only), LOST, STOLEN, RENEW","enum":["STOLEN","DAMAGED","LOST","RENEW"],"example":"STOLEN"},"externalRef":{"type":"string","description":"Client reference for the newly created card. Maximum of 50 alphanumeric characters (including underscore, hyphen and space).","maxLength":50,"minLength":1,"pattern":"[\\w-\\s]*"},"design":{"$ref":"#/components/schemas/card.ProductDesignDetail","description":"Design references for physical card and packaging"},"expiry":{"type":"string","description":"ISO 8601 date with year & month components only. The supplied value must be in the future (cannot be the current month) and is _inclusive_ of the specified month. If no expiry is selected, the standard product expiry date will be set","example":"2026-12"},"shippingAddress":{"$ref":"#/components/schemas/card.AddressDetail","description":"Shipping address details for card. Optional for individual customers whose partner has verification type EXTERNAL"}},"required":["reason"]},"account.AssociateResponse":{"type":"object","description":"Associate","properties":{"id":{"type":"string","description":"Unique id for the Associate"},"firstName":{"type":"string","description":"Associate's first name(s)"},"middleName":{"type":"string","description":"Associate's middle name"},"lastName":{"type":"string","description":"Associate's surname"},"email":{"type":"string","description":"Associate's email address"},"phone":{"type":"string","description":"Associate's phone number, in international number format"},"applicant":{"type":"boolean","description":"Indicates which Associate originally applied for the Modulr account"},"ownership":{"type":"integer","format":"int32","description":"The Associate's percentage ownership of the Customer"},"type":{"type":"string","description":"Describes the relation between the Associate and the Customer. Can be one of "},"dateOfBirth":{"type":"string","description":"Associate's date of birth in format yyyy-MM-dd, or format yyyy-MM where day is unknown"},"verificationStatus":{"type":"string","description":"How the Associate was verified. Can be one of "},"homeAddress":{"$ref":"#/components/schemas/account.AddressResponse","description":"Home address of the Associate"},"documentInfo":{"type":"array","description":"Documents gathered during Customer Due Diligence checks on an Associate.","items":{"$ref":"#/components/schemas/account.DocumentInfo"}},"additionalPersonalIdentifiers":{"type":"array","description":"Additional personal identifier(s)","items":{"$ref":"#/components/schemas/account.AdditionalPersonalIdentifierResponse"}},"complianceData":{"$ref":"#/components/schemas/account.AssociateComplianceDataResponse","description":"Optional for associates of type C_INTEREST and an EU customer legal entity. Mandatory for associates of type PREQUALIFIED. Not to be set for other associate types and/or for UK customer legal entity."}}},"directdebit.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"account.externalRef":{"type":"array","description":"A list of external references to filter","items":{"type":"string","description":"A list of external references to filter"}},"channelmanager.CardCustomFieldResponse":{"type":"object","properties":{"key":{"type":"string","description":"Custom field key"},"value":{"type":"string","description":"Custom field value"}}},"card.CardConstraints":{"type":"object","properties":{"mccWhitelist":{"type":"array","description":"mccWhitelist","example":["1000","1002-3000","5060"],"items":{"type":"string"}},"authorisation":{"$ref":"#/components/schemas/card.AuthorisationConstraints","description":"Authorisation constraints"}},"required":["mccWhitelist"]},"cardsimulator.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"account.DocumentInfo":{"type":"object","description":"Document","properties":{"path":{"type":"string","minLength":1},"fileName":{"type":"string","minLength":1},"uploadedDate":{"type":"string","description":"Valid date. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000","example":"2017-01-28T01:01:01+0000","minLength":1}},"required":["fileName","path","uploadedDate"]},"card.UpdateCardCustomFieldsRequest":{"type":"object","description":"Custom fields to be updated","properties":{"customFields":{"type":"array","description":"Custom fields","items":{"$ref":"#/components/schemas/card.CardCustomFieldRequest"},"maxItems":20,"minItems":1}},"required":["customFields"]},"pispgateway.PaymentAmount":{"type":"object","description":"The amount of the payment","properties":{"currency":{"type":"string","description":"Currency of the account in ISO 4217 format. Only allowable value is GBP","enum":["GBP"]},"value":{"type":"number","description":"Amount of the payment in Major Currency Units - '1' = 1.00 GBP","example":"100.00","maximum":2147483647,"minimum":0.01}},"required":["currency","value"]},"card.CardAuthentication":{"type":"object","properties":{"knowledgeBase":{"type":"array","description":"3DS knowledge-based authentication (KBA) answers","items":{"$ref":"#/components/schemas/card.CardKnowledgeBasedAuthentication"},"minItems":1}},"required":["knowledgeBase"]},"directdebit.ReconciliationResponse":{"type":"object","properties":{"reconciliationId":{"type":"string"},"accountId":{"type":"string"},"collectionDate":{"type":"string","format":"date"},"amount":{"type":"number"},"currency":{"type":"string"},"status":{"type":"string"},"notifiedDate":{"type":"string","format":"date-time"},"schemeDetails":{"type":"object","additionalProperties":{}}}},"account.BrandNameResponse":{"type":"object","description":"BrandName","properties":{"id":{"type":"string","description":"Unique id for the Brand Name"},"name":{"type":"string","description":"The Brand Name"}}},"channelmanager.WebhookNotificationResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the notification"},"type":{"type":"string","description":"Webhook type","enum":["PAYIN","PAYOUT","CARD_AUTH","CARD_AUTH_OFFLINE"]},"status":{"type":"string","description":"Status of notification","enum":["ACTIVE","INACTIVE"]},"destination":{"type":"string","description":"URL destination"},"retry":{"type":"boolean","description":"Flag indicating whether failed webhooks should be retried"},"secret":{"type":"string","description":"Webhook secret, must be 32 chars"},"hmacAlgorithm":{"type":"string","description":"Signing algorithm that is used in Webhook HMAC calculation","enum":["hmac-sha1","hmac-sha256","hmac-sha384","hmac-sha512"]}}},"confirmationofpayee.JsonSrdAccount":{"type":"object","properties":{"sortCode":{"type":"string","description":"The sort code of one or more accounts that requires Secondary Reference Data to be provided when making account name check requests.\n","example":"123456"},"accountNumbers":{"type":"array","description":"Account numbers that require Secondary Reference Data. If empty, Secondary Reference Data is required for all name check requests for this sort code.","items":{"type":"string","description":"The account number of a specific account that requires Secondary Reference Data to be provided when making account name check requests.","example":"11111111"}}},"required":["sortCode"]},"payment.RegulatoryReporting":{"type":"object","properties":{"type":{"type":"string","description":"Regulatory Reporting Type","enum":["CRED","DEBT","BOTH"],"example":"CRED"},"regulatoryAuthority":{"$ref":"#/components/schemas/payment.RegulatoryAuthority","description":"Regulatory authority"},"structuredRegulatoryReporting":{"$ref":"#/components/schemas/payment.StructuredRegulatoryReporting","description":"Structured regulatory reporting"}}},"payment.StructuredRegulatoryReporting":{"type":"object","properties":{"code":{"type":"string","maxLength":3,"minLength":0},"amount":{"type":"number","description":"Amount of the payment in Major Current Units - '1' = 1.00 GBP","example":"100.00","maximum":2147483647,"minimum":0.01},"currencyCode":{"type":"string","description":"Currency of the account in ISO 4217 format. Default is GBP","enum":["GBP","EUR","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SLE","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","SHP","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"]},"information":{"type":"string","maxLength":35,"minLength":0}}},"card.AsyncTaskCreatedResponse":{"type":"object","properties":{"taskUrl":{"type":"string","description":"Url of card task resource"},"taskId":{"type":"string","description":"ID of card task"},"metaData":{"type":"object","additionalProperties":{"type":"string"},"description":"Meta data associated with async task response"}},"required":["taskId","taskUrl"]},"card.ReportTypeNotificationResponse":{"type":"object","properties":{"email":{"type":"string"}}},"pispgateway.Capability":{"type":"object","properties":{"type":{"type":"string","description":"Type of the capability.","enum":["SINGLE_IMMEDIATE","STANDING_ORDER","SWEEPING_VRP","COMMERCIAL_VRP"],"example":"SINGLE_IMMEDIATE"},"status":{"type":"string","description":"Status of the capability.","enum":["ENABLED","DISABLED"],"example":"ENABLED"}}},"card.JsonNode":{},"onboarding.AssociateComplianceDataResponse":{"type":"object","properties":{"relationship":{"type":"string"}}},"onboarding.DocumentDetail":{"type":"object","properties":{"countryOfIssue":{"type":"string","description":"The issuing country code (ISO Alpha-2)","enum":["AT","BE","BG","CY","CZ","DK","EE","FI","FR","DE","GR","HR","HU","IS","IE","IT","LV","LI","LT","LU","MT","NL","NO","PL","PT","RO","SK","SI","ES","SE","GB","MQ","YT","GP","GF","RE","MF","GI","GG","IM","JE","MC","CH","AD","SM","VA","AX","PM","BL","AL","MD","ME","MK","RS","AF","DZ","AS","AO","AI","AQ","AG","AR","AM","AW","AU","AZ","BS","BH","BD","BB","BY","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","VG","BN","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CK","CR","CU","CW","CD","DJ","DM","DO","TL","EC","EG","SV","GQ","ER","SZ","ET","FK","FO","FJ","PF","TF","GA","GM","GE","GH","GL","GD","GU","GT","GN","GW","GY","HT","HM","HN","HK","IN","ID","IR","IQ","IL","CI","JM","JP","JO","KZ","KE","KI","XK","KW","KG","LA","LB","LS","LR","LY","MO","MG","MW","MY","MV","ML","MH","MR","MU","MX","FM","MN","MS","MA","MZ","MM","NA","NR","NP","AN","NC","NZ","NI","NE","NG","NU","NF","KP","MP","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PR","QA","CG","RU","RW","SH","KN","LC","VC","WS","ST","SA","SN","SC","SL","SG","SX","SB","SO","ZA","KR","GS","SS","LK","SD","SR","SY","SJ","TW","TJ","TZ","TH","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","UM","US","UY","UZ","VU","VE","VN","VI","WF","EH","YE","ZM","ZW"]},"type":{"type":"string","description":"Type of document","enum":["PASSPORT","DRIVING_LICENCE","NATIONAL_IDENTITY_CARD","VOTER_ID","WORK_PERMIT","OTHER_PROOF_OF_IDENTITY"]},"value":{"type":"string","description":"The document number","maxLength":20,"minLength":0}},"required":["value"]},"card.BulkCardsInfoResponse":{"type":"object","properties":{"id":{"type":"string"},"source":{"type":"string","enum":["API","FILE_UPLOAD"]},"originalName":{"type":"string"},"submissionTime":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["SUBMITTED","VALIDATED","VALIDATED_WITH_ERRORS","PROCESSING","PARTIALLY_PROCESSED_WITH_ERRORS","PARTIALLY_PROCESSED","PROCESSED","ARCHIVED","DELETED"]},"totalOperations":{"type":"integer","format":"int64"},"successfulOperations":{"type":"integer","format":"int64"},"failedOperations":{"type":"integer","format":"int64"},"processedOperations":{"type":"integer","format":"int64"},"createdBy":{"type":"string"},"externalRef":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/card.Error"}}}},"card.OtpDetails":{"type":"object","properties":{"deliveryDetails":{"type":"string","description":"OTP delivery details","example":"+447777123456"},"deliveryMethod":{"type":"string","description":"OTP delivery method","enum":["SMS","EMAIL","CALL_CENTRE","AUTOMATED_CALL_CENTRE","WEB","APP","PHONE_CALL","NONE"],"example":"SMS"},"expiry":{"type":"string","format":"date-time","description":"OTP expiry date and time (UTC, ISO 8601 format)","example":"2021-10-31T14:01:55+0000"},"verificationCode":{"type":"string","description":"OTP","example":"393805"}},"required":["deliveryDetails","deliveryMethod","expiry","verificationCode"]},"channelmanager.AuthorisationWindow":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"Authorisation window start date"},"endDate":{"type":"string","format":"date-time","description":"Authorisation window end date"}}},"account.CustomerTrustRequest":{"type":"object","properties":{"trustNature":{"type":"string","description":"Trust nature for customers of type Trust. Mandatory for type Trust, not to be set for non-trust customers.","enum":["BARE_TRUSTS","INTEREST_IN_POSSESSION_TRUSTS","DISCRETIONARY_TRUSTS","ACCUMULATION_TRUSTS","MIXED_TRUSTS","SETTLOR_INTERESTED_TRUSTS","NON_RESIDENT_TRUSTS","OFFSHORE_TRUSTS","FAMILY_LIVING_TRUST","PILOT_TRUST","VULNERABLE_BENEFICIARY_TRUST","CHARITABLE_TRUSTS","IRREVOCABLE_LIFE_INSURANCE_TRUST","TESTAMENTARY_TRUSTS","OTHER"]}},"required":["trustNature"]},"account.CustomerTaxProfileResponse":{"type":"object","properties":{"taxIdentifier":{"type":"string","description":"Tax identifier for customers of type SOLETRADER. Optional for type SOLETRADER, not to be set for non-SOLETRADER customers."}}},"integrationnotification.WebhookTypeConfiguration":{"type":"object","description":"Optional webhook type specific configuration","properties":{"amountThreshold":{"type":"number","description":"Amount threshold used to determine whether PAYIN webhooks should be sent.","minimum":0}}},"onboarding.AssociateResponse":{"type":"object","description":"Associate","properties":{"id":{"type":"string","description":"Unique id for the Associate"},"firstName":{"type":"string","description":"Associate's first name(s)"},"middleName":{"type":"string","description":"Associate's middle name"},"lastName":{"type":"string","description":"Associate's surname"},"email":{"type":"string","description":"Associate's email address"},"phone":{"type":"string","description":"Associate's phone number, in international number format"},"applicant":{"type":"boolean","description":"Indicates which Associate originally applied for the Modulr account"},"ownership":{"type":"integer","format":"int32","description":"The Associate's percentage ownership of the Customer"},"type":{"type":"string","description":"Describes the relation between the Associate and the Customer. Can be one of "},"dateOfBirth":{"type":"string","description":"Associate's date of birth in format yyyy-MM-dd, or format yyyy-MM where day is unknown"},"verificationStatus":{"type":"string","description":"How the Associate was verified. Can be one of "},"homeAddress":{"$ref":"#/components/schemas/onboarding.AddressResponse","description":"Home address of the Associate"},"documentInfo":{"type":"array","description":"Documents gathered during Customer Due Diligence checks on an Associate.","items":{"$ref":"#/components/schemas/onboarding.DocumentInfo"}},"additionalPersonalIdentifiers":{"type":"array","description":"Additional personal identifier(s)","items":{"$ref":"#/components/schemas/onboarding.AdditionalPersonalIdentifierResponse"}},"complianceData":{"$ref":"#/components/schemas/onboarding.AssociateComplianceDataResponse","description":"Optional for associates of type C_INTEREST and an EU customer legal entity. Mandatory for associates of type PREQUALIFIED. Not to be set for other associate types and/or for UK customer legal entity."}},"required":["dateOfBirth","firstName","id","lastName","type","verificationStatus"]},"payment.UltimatePayer":{"type":"object","properties":{"name":{"type":"string","description":"Name of the ultimate payer","maxLength":70,"minLength":0},"address":{"$ref":"#/components/schemas/payment.Address"},"birthDetails":{"$ref":"#/components/schemas/payment.BirthDetails","description":"Birth details of a person. Official identification details. Property 'birthDetails' and/or 'officialIdentification' Or 'officialIdDetailOrgs' is mandatory"},"officialIdentification":{"$ref":"#/components/schemas/payment.OfficialIdDetails","description":"Official identification for a person. Property 'birthDetails' and/or 'officialIdentification' Or 'officialIdDetailOrgs' is mandatory"},"officialIdDetailOrgs":{"$ref":"#/components/schemas/payment.OfficialOrganisationIdentity","description":"Organisation's official identification. Official identification details. Property 'birthDetails' and/or 'officialIdentification' Or 'officialIdDetailOrgs' is mandatory"},"overseasAccountIdentifier":{"$ref":"#/components/schemas/payment.OverseasAccountIdentifier"},"bic":{"type":"string","description":"Destination beneficiary's BIC/Swift Code.","example":"MODRDEFF123","pattern":"^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"}},"required":["address","name"]},"onboarding.SourceOfWealthRequest":{"type":"object","properties":{"standard":{"type":"string"},"pep":{"type":"string"}}},"pispgateway.PostalAddress":{"type":"object","properties":{"addressType":{"type":"string","description":"Identifies the nature of the postal address. BIZZ (Business), DLVY (Delivery), MLTO (Mail To), PBOX (PO Box), ADDR (Postal), HOME (Residential), CORR (Correspondence), STAT (Statement).","enum":["BIZZ","DLVY","MLTO","PBOX","ADDR","HOME","CORR","STAT"]},"department":{"type":"string","description":"Identification of a division of a large organisation or building.","maxLength":70,"minLength":1},"subDepartment":{"type":"string","description":"Identification of a sub-division of a large organisation or building.","maxLength":70,"minLength":1},"streetName":{"type":"string","description":"Name of a street or thoroughfare.","maxLength":140,"minLength":1},"buildingNumber":{"type":"string","description":"Number that identifies the position of a building on a street.","maxLength":16,"minLength":1},"buildingName":{"type":"string","description":"Name of a referenced building.","maxLength":140,"minLength":1},"floor":{"type":"string","description":"Number that identifies the level within a building.","maxLength":70,"minLength":1},"unitNumber":{"type":"string","description":"Number that identifies the unit of a specific address.","maxLength":16,"minLength":1},"room":{"type":"string","description":"Information that locates and identifies a room to form part of an address.","maxLength":70,"minLength":1},"postBox":{"type":"string","description":"Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.","maxLength":16,"minLength":1},"townLocationName":{"type":"string","description":"Name of a built-up area, with defined boundaries, and a local government.","maxLength":140,"minLength":1},"districtName":{"type":"string","description":"Number that of the regional area, known as a district, which forms part of an address.","maxLength":140,"minLength":1},"careOf":{"type":"string","description":"The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.","maxLength":140,"minLength":1},"postCode":{"type":"string","description":"Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.","maxLength":16,"minLength":1},"townName":{"type":"string","description":"Name of a built-up area, with defined boundaries, and a local government.","maxLength":140,"minLength":1},"countrySubDivision":{"type":"string","description":"Identifies a subdivision of a country such as state, region, county.","maxLength":35,"minLength":1},"country":{"type":"string","description":"Nation with its own government, as an ISO 3166-1 alpha-2 country code.","example":"GB","pattern":"^[A-Z]{2,2}$"},"addressLine":{"type":"array","description":"Information that locates and identifies a specific address, as defined by postal services, presented in free format text. Maximum 7 lines, each up to 70 characters.","items":{"type":"string"}}}},"payment.SchemeInfo":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"message":{"type":"string"},"responseCode":{"type":"string"}}},"card.AppleInAppProvisioningRequest":{"type":"object","description":"Apple in app provisioning request","properties":{"leafCertificate":{"type":"string","description":"Apple issued public base 64 encoded certificate to encrypt the provisioning data","minLength":1},"additionalCertificates":{"type":"array","description":"Apple issued public base 64 encoded certificates that complete the chain including the root certificate","items":{"type":"string"}},"nonce":{"type":"string","description":"Hex encoded nonce generated by the client","minLength":1},"nonceSignature":{"type":"string","description":"Hex encoded nonce signed with the private key to verify the certificate public key","minLength":1}},"required":["additionalCertificates","leafCertificate","nonce","nonceSignature"]},"inboundpayment.SchemeInfoRequest":{"type":"object","properties":{"id":{"type":"string","description":"unique id that identifies a payment end-to-end within a scheme. If used ensure that its unique"}}},"pispgateway.StandingOrderInitiationResponse":{"type":"object","description":"Response object for Get Standing Order Initiation","properties":{"id":{"type":"string","description":"The identifier of the standing order initiation","example":"I000000001"},"payment":{"$ref":"#/components/schemas/pispgateway.StandingOrderPayment","description":"The payment of the standing order"},"schedule":{"$ref":"#/components/schemas/pispgateway.StandingOrderSchedule","description":"The schedule of the standing order"},"status":{"type":"string","description":"The status of the standing order initiation, can be one of SUBMITTED, AWAITING_CONSENT, CONSENT_REJECTED, EXECUTED, ER_EXPIRED, ER_EXTSYS, ER_GENERAL","example":"AWAITING_CONSENT"},"aspspId":{"type":"string","description":"The identifier of the ASPSP used for the standing order","example":"H100000001"},"standingOrderStatus":{"type":"string","description":"The status of the standing order at the ASPSP. When available, this is passed through from the ASPSP without modification.","example":"InitiationCompleted"}}},"card.Add":{"allOf":[{"$ref":"#/components/schemas/card.PatchOperation"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/card.JsonNode"}}}],"description":"Add field","required":["op","path","value"]},"pispgateway.OBRisk":{"type":"object","properties":{"merchantCategoryCode":{"type":"string","description":"Category code conforming to ISO 18245, related to the type of services or goods the merchant provides.","maxLength":4,"minLength":3},"merchantCustomerIdentification":{"type":"string","description":"The unique customer identifier of the PSU with the merchant.","maxLength":70,"minLength":1},"contractPresentIndicator":{"type":"boolean","description":"Indicates if Payee has a contractual relationship with the PISP."},"beneficiaryPrepopulatedIndicator":{"type":"boolean","description":"Indicates if PISP has immutably prepopulated payment details for the PSU."},"beneficiaryAccountType":{"type":"string","description":"Specifies the extended type of beneficiary account if known.","enum":["Business","BusinessSavingsAccount","Charity","Collection","Corporate","Ewallet","Government","Investment","ISA","JointPersonal","Pension","Personal","PersonalSavingsAccount","Premier","Wealth"]},"deliveryAddress":{"$ref":"#/components/schemas/pispgateway.PostalAddress","description":"Information that locates and identifies a delivery address."}},"required":["beneficiaryPrepopulatedIndicator","contractPresentIndicator","merchantCategoryCode","merchantCustomerIdentification"]},"rule.RuleConfigData":{"type":"object","description":"Configuration fields for all types of rules. To be populated where applicable based on rule type.","properties":{"daysToRun":{"type":"array","description":"Day(s) of the week the rule is to run. e.g. [\"MONDAY\",\"TUESDAY\",\"WEDNESDAY\",\"THURSDAY\",\"FRIDAY\",\"SATURDAY\",\"SUNDAY\"]. Sweep Rule Only","items":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]}},"frequency":{"type":"string","description":"Frequency of the rule. Sweep Rule Only","enum":["Daily"]},"destinationId":{"type":"string","description":"Id of destination beneficiary. e.g. B1000001. Sweep Rule Only"},"balanceToLeave":{"type":"number","description":"Balance to be left after the rule has been ran. e.g. 100.00. Sweep Rule Only"},"triggerBalance":{"type":"number","description":"Minimum balance required to trigger the rule. e.g. 100.00. Sweep Rule Only"},"splits":{"type":"array","items":{"$ref":"#/components/schemas/rule.SplitConfig"}},"conditionalSplits":{"type":"array","items":{"$ref":"#/components/schemas/rule.SplitConfig"}},"conditionalSplitConfig":{"$ref":"#/components/schemas/rule.ConditionalSplitConfig"},"sourceId":{"type":"string","description":"Account to fund the supplied accountId. e.g. A1000002. Funding Rule Only"}}},"card.reportTypes":{"type":"array","description":"Report types","example":"DAILY_CARD_ACTIVITY","items":{"type":"string","description":"Report types","enum":["DAILY_CARD_ACTIVITY","MONTHLY_CARD_ACTIVITY","DAILY_ACCOUNT_FUNDING","MONTHLY_ACCOUNT_FUNDING","DAILY_AUTH_WINDOW","DAILY_CARD_MANAGEMENT"],"example":"DAILY_CARD_ACTIVITY"}},"pispgateway.CreateStandingOrderInitiationResponse":{"type":"object","description":"Response object to Initiate Standing Order","properties":{"standingOrderInitiationId":{"type":"string","description":"The unique identifier of the standing order initiation request at Modulr","example":"I000000001"},"redirectUrl":{"type":"string","description":"A redirect URL for the user to authorise the standing order initiation request at the ASPSP","example":"https://www.bankofmoney.com/authorize"}}},"channelmanager.CardHolder":{"type":"object","properties":{"title":{"type":"string","description":"Cardholder title is optional for all card types. Maximum of 4 alphanumeric characters.","example":"Mr","pattern":"^[0-9a-zA-Z]{1,4}$"},"firstName":{"type":"string","description":"Cardholder first name. Maximum of 20 alphanumeric characters including space, hyphen and apostrophe. Optional for individual customers whose partner has verification type EXTERNAL and for Virtual Business customers.","example":"Joe","pattern":"^[A-Za-z0-9ÄÖÜäöü/.'^ -]{1,20}$"},"lastName":{"type":"string","description":"Cardholder last name. Maximum of 20 alphanumeric characters including space, hyphen and apostrophe. Optional for individual customers whose partner has verification type EXTERNAL and for Virtual Business customers.","example":"Bloggs","pattern":"^[A-Za-z0-9ÄÖÜäöü/.'^ -]{1,20}$"},"billingAddress":{"$ref":"#/components/schemas/channelmanager.AddressDetail","description":"Billing address for the cardholder. Optional for individual customers whose partner has verification type EXTERNAL."},"dateOfBirth":{"type":"string","format":"date","description":"Cardholder date of birth. Must match date format of yyyy-mm-dd. Required for virtual consumer and physical cards. Optional for individual customers.","example":"2001-01-01"},"mobileNumber":{"type":"string","description":"Cardholder mobile number. Must start with a '+', followed by the country code and then the mobile number. Required for virtual consumer and physical cards.","example":"+447123456000"},"email":{"type":"string","format":"email","description":"Cardholder email","example":"cardholder@example.com","maxLength":50,"minLength":0}},"required":["firstName","lastName"]},"card.CardCustomFieldResponse":{"type":"object","properties":{"key":{"type":"string","description":"Custom field key"},"value":{"type":"string","description":"Custom field value"}}},"pispgateway.VrpPaymentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the VRP payment initiation request at Modulr","example":"V21000001E"},"status":{"type":"string","description":"The current status of vrp payment. Must be one of “SUBMITTED”, “ACCEPTEDWITHOUTPOSTING”, “ACCEPTEDSETTLEMENTINPROCESS”, “PENDING”, “REJECTED”, “ACCEPTEDCREDITSETTLEMENTCOMPLETED”, “ACCEPTEDSETTLEMENTCOMPLETED”, “RECEIVED”, “CANCELLED”, “BLOCKED”, “ACCEPTEDTECHNICALVALIDATION”, “ACCEPTEDCUSTOMERPROFILE”, “ACCEPTEDFUNDSCHECKED”, “ACCEPTEDWITHCHANGE”, “ACCEPTEDSETTLEMENTCOMPLETEDCREDITORACCOUNT”, “ACCEPTEDSETTLEMENTCOMPLETEDDEBITORACCOUNT”, “ER_GENERAL”, “ER_EXTSYS”","enum":["SUBMITTED","ACCEPTEDWITHOUTPOSTING","ACCEPTEDSETTLEMENTINPROCESS","PENDING","REJECTED","ACCEPTEDCREDITSETTLEMENTCOMPLETED","ACCEPTEDSETTLEMENTCOMPLETED","RECEIVED","CANCELLED","BLOCKED","ACCEPTEDTECHNICALVALIDATION","ACCEPTEDCUSTOMERPROFILE","ACCEPTEDFUNDSCHECKED","ACCEPTEDWITHCHANGE","ACCEPTEDSETTLEMENTCOMPLETEDCREDITORACCOUNT","ACCEPTEDSETTLEMENTCOMPLETEDDEBITORACCOUNT","ER_GENERAL","ER_EXTSYS"]}},"required":["status"]},"verificationofpayee.OutboundVopResponseResult":{"type":"object","description":"Verify Payee Result","properties":{"code":{"type":"string","description":"The result of verify payee.","enum":["MATCH","NO_MATCH","CLOSE_MATCH","CHECK_NOT_POSSIBLE"],"example":"MATCH"},"matchedName":{"type":"string","description":"The actual name of the payee","example":"Joseph Bloggs"}},"required":["code"]},"directdebit.CancelMandateRequest":{"type":"object","description":"Details of Mandate cancellation.","properties":{"reason":{"type":"string","description":"Reason to cancel the mandate","minLength":1}},"required":["reason"]},"account.UpdateCustomerRequest":{"type":"object","description":"Details of customer to edit","properties":{"externalReference":{"type":"string","description":"External Reference can only have alphanumeric characters plus underscore, hyphen and space up to 50 characters long","maxLength":50,"minLength":0,"pattern":"[\\w \\-]*"},"associates":{"type":"array","description":"Applicable to all types except 'PCM_BUSINESS'","items":{"$ref":"#/components/schemas/account.UpdateAssociateRequest"}},"name":{"type":"string","description":"AlphaNumeric characters plus [ _ ' @ , & £ $ € ¥ = # % ‘ ’ : ; \\ / < > « »  ! ‘ “ ” . ? - *{ }  + % ( )]. Mandatory for all types except 'INDIVIDUAL and PCM_INDIVIDUAL'","maxLength":100,"minLength":0,"pattern":"^([_'@,&()£$€¥=#%\\‘\\’:;/<>«»\\\"!\\‘\\“\\”.\\?\\-\\s\\*\\{\\}\\[\\]\\+\\%\\\\]*?[\\p{L}0-9])+[_'@,&()£$€¥=#%\\‘\\’:;/<>«»\\\"!\\‘\\“\\”.\\?\\-\\s\\*\\{\\}\\[\\]\\+\\%\\\\]*"},"brandNames":{"type":"array","description":"The customers brand name(s)","items":{"$ref":"#/components/schemas/account.UpdateBrandNameRequest"}},"tradingAddress":{"$ref":"#/components/schemas/account.AddressRequest","description":"Applicable to all types except 'INDIVIDUAL' and 'PCM_INDIVIDUAL'"},"customerTrust":{"$ref":"#/components/schemas/account.CustomerTrustRequest","description":"Trust nature for customers of type Trust. Mandatory for type Trust, not to be set for non-trust customers."},"complianceData":{"$ref":"#/components/schemas/account.CustomerComplianceDataRequest","description":"Required for customers of type PREQUALIFIED"}}},"account.SourceOfWealthResponse":{"type":"object","properties":{"standard":{"type":"string"},"pep":{"type":"string"}}},"onboarding.AdditionalPersonalIdentifierResponse":{"type":"object","description":"AdditionalPersonalIdentifier","properties":{"type":{"type":"string","description":"The type of Additional Personal Identifier","enum":["BSN"]},"value":{"type":"string","description":"Additional Personal Identifier value"}},"required":["type","value"]},"pispgateway.Payment":{"type":"object","properties":{"currency":{"type":"string","description":"Currency of the payment amount. Must be specified in ISO 4217 format."},"amount":{"type":"number","description":"Payment amount","example":"100.00"},"reference":{"type":"string","description":"A reference used to unambiguously refer to the payment transaction. Min 6 to max 18 characters. Can contain alphanumeric, '-', '.', '&', '/' and space."}},"required":["currency","reference"]},"customercompliance.AssociateResponse":{"type":"object","properties":{"id":{"type":"string","description":"Associate bid"}}},"card.CreateCardResponse":{"type":"object","properties":{"id":{"type":"string","description":"Card identifier. Maximum of 10 alphanumeric characters."},"pan":{"type":"string","description":"Full card PAN."},"maskedPan":{"type":"string","description":"Masked card PAN."},"cvv2":{"type":"string","description":"Card CVV2 number."},"externalRef":{"type":"string","description":"Client reference for the newly created card."},"createdDate":{"type":"string","format":"date-time","description":"The creation date of the card","example":"2019-01-29T11:01:54.826+0000"},"maxLimit":{"type":"string","description":"Maximum Limit which can be set on this card and is the maximum lifetime spend the card can have","example":"4000.00"},"frequencyUsage":{"type":"string","description":"Card frequency usage","enum":["SINGLE_USE","MULTI_USE"],"example":"MULTI_USE"},"shareLink":{"type":"string","description":"Link that can be used by client to share secure details. Will only be returned when shareDetails method is RETURN in request body."}},"required":["createdDate","cvv2","externalRef","frequencyUsage","id","maxLimit","pan"]},"notification.NotificationRequest":{"type":"object","properties":{"type":{"type":"string","description":"Type of the notification.","enum":["PAYIN","PAYOUT","BALANCE_LOW","BALANCE_HIGH","BALANCE","DDMANDATE","CUSTVSTAT","ACCOUNT_STATEMENT","PENDING_PAYMENTS","DD_INCOMING_DEBIT","DD_FAILED_CLAIM","DD_FUNDS_RETURNED","CARD_AUTH","CARD_AUTH_OFFLINE","CARD_CREATION","UPCOMING_CREDIT","UPCOMING_COLLECTION_CREDIT","UPCOMING_COLLECTION_DEBIT","CARD_STATUS_UPDATE","CARD_TOKEN_PROVISIONING","PAYMENT_COMPLIANCE_STATUS","DD_COLLECTION_STATUS","ACCOUNT_SWITCH_UPDATE","PAYMENT_FILE_UPLOAD","ACCOUNT_STATUS_CHANGE","PAYMENT_APPROVAL_STATUS_CHANGE","CUSTOMER_BATCH_PAYMENT_APPROVAL_STATUS_CHANGE","CARD_BULK_OPS_COMPLETED","CUSTOMER_STATUS","CREDIT_AUTH","DD_INDEMNITY_CLAIM_STATUS","APPLICATION_STATUS_CHANGE","CUSTOMER_CREATED"]},"channel":{"type":"string","description":"Channel used for sending the notification","enum":["EMAIL","WEBHOOK"]},"destinations":{"type":"array","description":"The list of emails or url(webhook) used for sending the notification. For 'EMAIL' channel this can be a list of comma separated email addresses. For 'WEBHOOK' channel this should be a single URL.","items":{"type":"string"},"minItems":1},"config":{"$ref":"#/components/schemas/notification.NotificationConfig","description":"Configuration information for this Notification entity."}},"required":["channel","config","destinations","type"]},"rule.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"onboarding.Accountancy":{"type":"object","properties":{"directEmployeesOnly":{"type":"boolean"},"companyFormationServices":{"type":"boolean"},"amlBodySupervision":{"type":"boolean"},"amlPolicy":{"$ref":"#/components/schemas/onboarding.DocumentInfo"},"amlOfficer":{"type":"string"}},"required":["amlBodySupervision","amlOfficer","companyFormationServices","directEmployeesOnly"]},"channelmanager.Add":{"allOf":[{"$ref":"#/components/schemas/channelmanager.PatchOperation"},{"type":"object","properties":{"value":{"$ref":"#/components/schemas/channelmanager.JsonNode"}}}],"description":"Add field","required":["op","path","value"]},"onboarding.CreateApplicationResponse":{"type":"object","properties":{"id":{"type":"string"}}},"payment.MessageResponse":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string","enum":["GENERAL","BUSINESSRULE","MFASTATUS","MFAERROR","MFATIMEOUT","MFADEVICEMM","MFAMESSAGEINVALID","NOTFOUND","DUPLICATE","INVALID","CONNECTION","RETRY","RATELIMIT","PERMISSION","NOTACCEPTABLE","MFAVERIFICATION","TOKENEXPIRED"]},"errorCode":{"type":"string"},"message":{"type":"string"},"sourceService":{"type":"string"}}},"paymentfileupload.FilesCreatePaymentsRequest":{"type":"object","description":"Request body containing file IDs to process for payment creation","properties":{"fileIds":{"type":"array","description":"List of fileIds to create payments from","items":{"type":"string"},"maxItems":10,"minItems":0},"useDuplicate":{"type":"boolean","description":"When true, duplicate files will be processed - Applies to all fileIds in this request"}},"required":["fileIds"]},"inboundpayment.AccountIdentifierDetailRequest":{"type":"object","properties":{"type":{"type":"string","description":"Account identifier type","enum":["SCAN","IBAN","DD","INTL","ANBRN","AN"]},"accountNumber":{"type":"string","description":"Account number"},"sortCode":{"type":"string","description":"Sortcode"},"iban":{"type":"string","description":"IBAN"},"bic":{"type":"string","description":"BIC"}},"required":["type"]},"document.DocumentUploadRequest":{"type":"object","properties":{"fileName":{"type":"string","maxLength":100,"minLength":0,"pattern":"^[\\w,\\s-.]+\\.(\\w){3,4}$"},"content":{"type":"string","description":"Needs to be Base64 encoded","minLength":1},"group":{"type":"string","description":"Use to group documents together. Combination of group+filename should be unique else the files will be overwritten","maxLength":100,"minLength":0}},"required":["content","fileName","group"]},"pispgateway.VrpConfirmationOfFundsRequest":{"type":"object","description":"Request object to confirm the availability of funds in account","properties":{"currency":{"type":"string","description":"Currency of the maximum individual amount. Must be specified in ISO 4217 format."},"amount":{"type":"number","description":"amount that will be confirmed for availability of funds - '1' = 1.00 GBP","example":"100.00"}},"required":["currency"]}},"securitySchemes":{"modulo_security":{"type":"apiKey","name":"Authorization","in":"header"},"TOKEN":{"type":"apiKey","name":"Authorization","in":"header"}}},"x-readme":{"proxy-enabled":false}}