{"openapi":"3.0.0","paths":{"/v1/partner/test":{"post":{"operationId":"PartnerController_postTest","parameters":[{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerTestRequest"}}}},"responses":{"201":{"description":"Returns message","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["Partners"]}},"/v1/partner/webhook-test":{"post":{"operationId":"PartnerController_webhookTest","parameters":[{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerTestRequest"}}}},"responses":{"201":{"description":""}},"tags":["Partners"]}},"/v1/partner/accounts/primary":{"post":{"operationId":"AccountController_createPrimaryAccount","summary":"Create a primary account","parameters":[{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCreatePrimaryAccountRequest"}}}},"responses":{"201":{"description":"Account successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPrimaryAccountResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Accounts"]}},"/v1/partner/accounts/virtual":{"post":{"operationId":"AccountController_createVirtualAccount","summary":"Create a virtual account","parameters":[{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCreateVirtualAccountRequest"}}}},"responses":{"201":{"description":"Account successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerVirtualAccountResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Parent account not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"412":{"description":"Precondition failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerAccountErrorResponse"}}}}},"tags":["Accounts"]}},"/v1/partner/accounts":{"get":{"operationId":"AccountController_getAllAccounts","summary":"Get all accounts","parameters":[{"name":"types","required":false,"in":"query","description":"List of account type to filter accounts. Multiple types can be specified.","example":["PRIMARY"],"schema":{"nullable":true,"default":["PRIMARY","VIRTUAL","PROGRAM"],"type":"array","items":{"type":"string","enum":["PRIMARY","VIRTUAL","PROGRAM"]}}},{"name":"primaryAccountId","required":false,"in":"query","description":"Primary account ID to filter virtual accounts.","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","schema":{"format":"uuid","nullable":true,"type":"string"}},{"name":"states","required":false,"in":"query","description":"List of account states to filter results.","example":["READY"],"schema":{"nullable":true,"default":["READY"],"type":"array","items":{"type":"string","enum":["INITIALIZING","READY","BLOCKED","CLOSED","SUSPENDED"]}}},{"name":"page","required":true,"in":"query","description":"Page number for paginated results.","example":1,"schema":{"default":1,"type":"number"}},{"name":"limit","required":true,"in":"query","description":"Number of accounts per page.","example":10,"schema":{"maximum":100,"default":10,"type":"number"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"List of accounts available to the partner","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Pagination"},{"properties":{"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PartnerPrimaryAccountResponse"},{"$ref":"#/components/schemas/PartnerVirtualAccountResponse"},{"$ref":"#/components/schemas/PartnerProgramAccountResponse"}]}},"meta":{"type":"object","properties":{"currentPage":{"type":"number","example":1},"itemCount":{"type":"number","example":10},"itemsPerPage":{"type":"number","example":10},"totalItems":{"type":"number","example":100},"totalPages":{"type":"number","example":10}}}}}]}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerAccountErrorResponse"}}}}},"tags":["Accounts"]}},"/v1/partner/accounts/{accountId}":{"get":{"operationId":"AccountController_getAccountById","summary":"Get account","parameters":[{"name":"accountId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the account details","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PartnerPrimaryAccountResponse"},{"$ref":"#/components/schemas/PartnerVirtualAccountResponse"},{"$ref":"#/components/schemas/PartnerProgramAccountResponse"}]}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Account not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerAccountErrorResponse"}}}}},"tags":["Accounts"]}},"/v1/partner/accounts/{accountId}/balance":{"get":{"operationId":"AccountController_getAccountBalance","summary":"Get account balance","parameters":[{"name":"accountId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns account real-time balance positions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerAccountBalanceResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Account not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerAccountErrorResponse"}}}}},"tags":["Accounts"]}},"/v1/partner/accounts/virtual/{accountId}":{"delete":{"operationId":"AccountController_closeVirtualAccount","summary":"Delete a virtual account","parameters":[{"name":"accountId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerDeleteVirtualAccountRequest"}}}},"responses":{"200":{"description":"Virtual account deleted"},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Account not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"412":{"description":"Precondition failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerAccountErrorResponse"}}}}},"tags":["Accounts"]}},"/v1/partner/automated-payments/customers/{customerId}":{"get":{"operationId":"AutomatedPaymentController_getCustomerAutomatedPayments","summary":"Get customer automated payments","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"stateTypes","required":true,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PartnerAutomatedPaymentResponse"}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Automated Payments"]}},"/v1/partner/automated-payments/customers/{customerId}/{automatedPaymentId}":{"get":{"operationId":"AutomatedPaymentController_getCustomerAutomatedPaymentById","summary":"Get customer automated payment","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"automatedPaymentId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerAutomatedPaymentResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Automated Payments"]},"delete":{"operationId":"AutomatedPaymentController_revokeCustomerAutomatedPayment","summary":"Revoke customer automated payment","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"automatedPaymentId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerRevokeAutomatedPaymentRequest"}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Automated Payments"]}},"/v1/partner/automated-payments/customers/{customerId}/{automatedPaymentId}/states":{"get":{"operationId":"AutomatedPaymentController_getCustomerAutomatedPaymentStates","summary":"Get customer automated payment states","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"automatedPaymentId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PartnerAutomatedPaymentStateResponse"}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Automated Payments"]}},"/v1/partner/automated-payments/accounts/{accountId}":{"get":{"operationId":"AutomatedPaymentController_getAccountAutomatedPayments","summary":"Get account automated payments","parameters":[{"name":"accountId","required":true,"in":"path","schema":{"type":"string"}},{"name":"stateTypes","required":true,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PartnerAutomatedPaymentResponse"}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Automated Payments"]}},"/v1/partner/customers/{customerId}/accounts":{"get":{"operationId":"CustomerController_getCustomerAccounts","summary":"Get customer accounts","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"types","required":false,"in":"query","description":"List of account type to filter accounts. Multiple types can be specified.","example":["PRIMARY"],"schema":{"nullable":true,"default":["PRIMARY","VIRTUAL","PROGRAM"],"type":"array","items":{"type":"string","enum":["PRIMARY","VIRTUAL","PROGRAM"]}}},{"name":"primaryAccountId","required":false,"in":"query","description":"Primary account ID to filter virtual accounts.","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","schema":{"format":"uuid","nullable":true,"type":"string"}},{"name":"states","required":false,"in":"query","description":"List of account states to filter results.","example":["READY"],"schema":{"nullable":true,"default":["READY"],"type":"array","items":{"type":"string","enum":["INITIALIZING","READY","BLOCKED","CLOSED","SUSPENDED"]}}},{"name":"page","required":true,"in":"query","description":"Page number for paginated results.","example":1,"schema":{"default":1,"type":"number"}},{"name":"limit","required":true,"in":"query","description":"Number of accounts per page.","example":10,"schema":{"maximum":100,"default":10,"type":"number"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"List of accounts available to the partner","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Pagination"},{"properties":{"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PartnerPrimaryAccountResponse"},{"$ref":"#/components/schemas/PartnerVirtualAccountResponse"}]}},"meta":{"type":"object","properties":{"currentPage":{"type":"number","example":1},"itemCount":{"type":"number","example":10},"itemsPerPage":{"type":"number","example":10},"totalItems":{"type":"number","example":100},"totalPages":{"type":"number","example":10}}}}}]}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerAccountErrorResponse"}}}}},"tags":["Customers"]}},"/v1/partner/customers/{customerId}/accounts/{accountId}":{"get":{"operationId":"CustomerController_getCustomerAccountById","summary":"Get customer account","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"accountId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the account details","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PartnerPrimaryAccountResponse"},{"$ref":"#/components/schemas/PartnerVirtualAccountResponse"}]}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Account not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerAccountErrorResponse"}}}}},"tags":["Customers"]}},"/v1/partner/customers/{customerId}/accounts/{accountId}/balance":{"get":{"operationId":"CustomerController_getCustomerAccountBalance","summary":"Get customer account balance","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"accountId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns account real-time balance positions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerAccountBalanceResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Account not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerAccountErrorResponse"}}}}},"tags":["Customers"]}},"/v1/partner/customers/{customerId}/transactions":{"get":{"operationId":"CustomerController_getCustomerTransactions","summary":"Get customer transactions","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"accountIds","required":false,"in":"query","description":"List of account IDs to filter transactions. If not provided, transactions from all accessible accounts are included.","example":["e0cab2dd-739f-43de-b131-3e423e935bf1"],"schema":{"type":"array","items":{"type":"string"}}},{"name":"fromDate","required":false,"in":"query","description":"Start date for filtering transactions (inclusive). Expected format: YYYY-MM-DD. No lower bound if omitted.","example":"2025-01-01","schema":{"nullable":true,"type":"string"}},{"name":"toDate","required":false,"in":"query","description":"End date for filtering transactions (inclusive). Expected format: YYYY-MM-DD. No upper bound if omitted.","example":"2025-12-31","schema":{"nullable":true,"type":"string"}},{"name":"origins","required":false,"in":"query","description":"Filter transactions by their origin (e.g., Transfer, Deposit, Withdrawal). Multiple values allowed.","example":["TRANSFER","CARD"],"schema":{"nullable":true,"type":"array","items":{"type":"string","enum":["TRANSFER","CARD","AUTOMATED_PAYMENT","INVESTMENTS"]}}},{"name":"states","required":false,"in":"query","description":"Filter transactions by their state (e.g., Completed, Pending, Failed). Multiple values allowed.","example":["COMPLETED","PENDING"],"schema":{"nullable":true,"type":"array","items":{"type":"string","enum":["EXPECTED","PENDING","COMPLETED","CANCELLED","FAILED"]}}},{"name":"transactionAccountIncludeTypes","required":false,"in":"query","description":"Filter transactions by their account include type (e.g., Customer account, Program account). Multiple values allowed.","example":["CUSTOMER_ACCOUNT","PROGRAM_ACCOUNT"],"schema":{"nullable":true,"default":["CUSTOMER_ACCOUNT","PROGRAM_ACCOUNT"],"type":"array","items":{"type":"string","enum":["CUSTOMER_ACCOUNT","PROGRAM_ACCOUNT"]}}},{"name":"page","required":true,"in":"query","description":"Page number for paginated results. Starts from 1.","example":1,"schema":{"default":1,"type":"number"}},{"name":"limit","required":true,"in":"query","description":"Number of transactions per page. Maximum allowed value is 100.","example":10,"schema":{"maximum":100,"default":10,"type":"number"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"List of customer transactions","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Pagination"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PartnerTransactionResponse"}},"meta":{"type":"object","properties":{"currentPage":{"type":"number","example":1},"itemCount":{"type":"number","example":10},"itemsPerPage":{"type":"number","example":10},"totalItems":{"type":"number","example":100},"totalPages":{"type":"number","example":10}}}}}]}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Customers"]}},"/v1/partner/investments/product-variants":{"get":{"operationId":"InvestmentController_getProductVariants","summary":"Get all product variants","parameters":[{"name":"page","required":true,"in":"query","description":"Page number for paginated results.","example":1,"schema":{"default":1,"type":"number"}},{"name":"limit","required":true,"in":"query","description":"Number of product variants per page.","example":10,"schema":{"maximum":100,"default":10,"type":"number"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"List of product variants available to the partner","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Pagination"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PartnerProductVariantResponse"}},"meta":{"type":"object","properties":{"currentPage":{"type":"number","example":1},"itemCount":{"type":"number","example":10},"itemsPerPage":{"type":"number","example":10},"totalItems":{"type":"number","example":100},"totalPages":{"type":"number","example":10}}}}}]}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Investments"]}},"/v1/partner/investments/product-variants/{productVariantId}":{"get":{"operationId":"InvestmentController_getProductVariant","summary":"Get product variant","parameters":[{"name":"productVariantId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the product details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerProductVariantResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Product not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Investments"]}},"/v1/partner/investments/subscriptions":{"get":{"operationId":"InvestmentController_getSubscriptions","summary":"Get all subscriptions","parameters":[{"name":"page","required":true,"in":"query","description":"Page number for paginated results.","example":1,"schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":true,"in":"query","description":"Number of subscriptions per page.","example":10,"schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"customerIds","required":true,"in":"query","description":"Filter by customerIds.","example":["a2b9649e-df7f-4349-adff-1c57283fef10"],"schema":{"type":"array","items":{"type":"string"}}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"List of subscriptions available to the partner","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Pagination"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PartnerSubscriptionResponse"}},"meta":{"type":"object","properties":{"currentPage":{"type":"number","example":1},"itemCount":{"type":"number","example":10},"itemsPerPage":{"type":"number","example":10},"totalItems":{"type":"number","example":100},"totalPages":{"type":"number","example":10}}}}}]}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Investments"]},"post":{"operationId":"InvestmentController_subscribeToProduct","summary":"Create subscription","parameters":[{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCreateSubscriptionRequest"}}}},"responses":{"201":{"description":"Returns the subscription details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSubscriptionResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Subscription not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Investments"]}},"/v1/partner/investments/subscriptions/{subscriptionId}":{"get":{"operationId":"InvestmentController_getSubscription","summary":"Get subscription","parameters":[{"name":"subscriptionId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the subscription details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSubscriptionResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Subscription not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Investments"]}},"/v1/partner/investments/product-variants/{productVariantId}/returns":{"get":{"operationId":"InvestmentController_getProductVariantReturns","summary":"Get product variant returns","parameters":[{"name":"productVariantId","required":true,"in":"path","schema":{"type":"string"}},{"name":"amount","required":true,"in":"query","description":"Amount in minor units (e.g. 129 for £1.29)","example":10000,"schema":{"type":"number"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns calculated product return details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerProductVariantReturnsResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Product not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"412":{"description":"Amount lower than product's minimum amount. Try greater value","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Investments"]}},"/v1/partner/payments/customers/{customerId}/payments/internal":{"post":{"operationId":"PaymentController_createInternalPayment","summary":"Create internal payment","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentInternalPayload"}}}},"responses":{"201":{"description":"Returns payment id to be used in the next step","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Account Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"412":{"description":"Modulus / IBAN error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentErrorResponse"}}}}},"tags":["Payments"]}},"/v1/partner/payments/customers/{customerId}/payments/external":{"post":{"operationId":"PaymentController_createOutboundPaymentForCustomer","summary":"Create external payment using customer","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentExternalPayload"}}}},"responses":{"201":{"description":"Returns payment id to be used in the next step","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Account Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"412":{"description":"Precondition failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentErrorResponse"}}}}},"tags":["Payments"]}},"/v1/partner/payments/account":{"post":{"operationId":"PaymentController_createOutboundPaymentByAccount","summary":"Create external payment using account","parameters":[{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentExternalPayload"}}}},"responses":{"201":{"description":"Returns payment id to be used in the next step","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Account Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"412":{"description":"Precondition failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentErrorResponse"}}}}},"tags":["Payments"]}},"/v1/partner/payments/{paymentId}":{"get":{"operationId":"PaymentController_getPayment","summary":"Get payment","parameters":[{"name":"paymentId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns payment for given payment id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Payments"]}},"/v1/partner/payments/external-reference/{externalReference}":{"get":{"operationId":"PaymentController_getPaymentByExternalReference","summary":"Get payment using external reference","parameters":[{"name":"externalReference","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns payment for given external reference","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Payments"]}},"/v1/partner/payments/customers/{customerId}/validate-external-counterparty":{"post":{"operationId":"PaymentController_validateExternalCounterparty","summary":"Validate external counterparty","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerValidateCounterpartyPayload"}}}},"responses":{"201":{"description":"Returns external counterparty validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerValidateCounterpartyResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentErrorResponse"}}}}},"tags":["Payments"]}},"/v2/partner/payments/customers/{customerId}/validate-external-counterparty":{"post":{"operationId":"PaymentController_validateExternalCounterpartyV2","summary":"Validate external counterparty (v2)","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerValidateCounterpartyPayloadV2"}}}},"responses":{"201":{"description":"Returns external counterparty validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerValidateCounterpartyResponseV2"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentErrorResponse"}}}}},"tags":["Payments"]}},"/v1/partner/payments/customers/{customerId}/simulate-inbound-payment":{"post":{"operationId":"PaymentController_simulateInboundPayment","summary":"Simulate payment using customer","deprecated":true,"description":"Please use /v1/partner/payment-simulation/customers/:customerId/simulate-inbound-payment","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSimulateInboundPaymentPayload"}}}},"responses":{"201":{"description":"Simulate payment"},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Payments"]}},"/v1/partner/payments/account/simulate-inbound-payment":{"post":{"operationId":"PaymentController_simulateInboundPaymentForAccount","summary":"Simulate payment using account","deprecated":true,"description":"Please use /v1/partner/payment-simulation/account/simulate-inbound-payment","parameters":[{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSimulateInboundPaymentPayload"}}}},"responses":{"201":{"description":"Simulate payment"},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Payments"]}},"/v1/partner/payments/customers/{customerId}/payments/return":{"post":{"operationId":"PaymentController_createReturnTransfer","summary":"Initiate transaction return","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCreateReturnTransferPayload"}}}},"responses":{"201":{"description":"Returns transfer response for the initiated return","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"412":{"description":"Precondition failed. Payment cannot be returned due to unsupported transaction type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentErrorResponse"}}}}},"tags":["Payments"]}},"/v1/partner/payments/funding/sources":{"get":{"operationId":"PaymentFundingController_getFundingSources","summary":"Get funding sources","parameters":[{"name":"type","required":true,"in":"query","description":"Type of funding source to search","example":"PISP","schema":{"enum":["PISP"],"type":"string"}},{"name":"currency","required":true,"in":"query","description":"Currency supported by the funding source","example":"GBP","schema":{"enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the list of sources","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PartnerPaymentFundingSourceResponse"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Funding sources could not be retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentErrorResponse"}}}}},"tags":["Payments"]}},"/v1/partner/payments/funding/customers/{customerId}/initiate":{"post":{"operationId":"PaymentFundingController_initiateFunding","summary":"Initiate funding","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentFundingInitiatePayload"}}}},"responses":{"201":{"description":"Returns payment details and redirect url","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentFundingInitiateResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"408":{"description":"Request timeout, safe to retry with the same idempotencyKey","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentErrorResponse"}}}}},"tags":["Payments"]}},"/v1/partner/cards/external/funding/customers/{customerId}":{"post":{"operationId":"CardFundingController_initiateCardFunding","summary":"Initiate card funding","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCardFundingInitiatePayload"}}}},"responses":{"201":{"description":"Returns card funding initiation response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCardFundingResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPaymentErrorResponse"}}}}},"tags":["Cards"]}},"/v1/partner/transactions":{"get":{"operationId":"TransactionController_getTransactions","summary":"Get transactions","parameters":[{"name":"accountIds","required":false,"in":"query","description":"List of account IDs to filter transactions. If not provided, transactions from all accessible accounts are included.","example":["e0cab2dd-739f-43de-b131-3e423e935bf1"],"schema":{"type":"array","items":{"type":"string"}}},{"name":"fromDate","required":false,"in":"query","description":"Start date for filtering transactions (inclusive). Expected format: YYYY-MM-DD. No lower bound if omitted.","example":"2025-01-01","schema":{"nullable":true,"type":"string"}},{"name":"toDate","required":false,"in":"query","description":"End date for filtering transactions (inclusive). Expected format: YYYY-MM-DD. No upper bound if omitted.","example":"2025-12-31","schema":{"nullable":true,"type":"string"}},{"name":"origins","required":false,"in":"query","description":"Filter transactions by their origin (e.g., Transfer, Deposit, Withdrawal). Multiple values allowed.","example":["TRANSFER","CARD"],"schema":{"nullable":true,"type":"array","items":{"type":"string","enum":["TRANSFER","CARD","AUTOMATED_PAYMENT","INVESTMENTS"]}}},{"name":"states","required":false,"in":"query","description":"Filter transactions by their state (e.g., Completed, Pending, Failed). Multiple values allowed.","example":["COMPLETED","PENDING"],"schema":{"nullable":true,"type":"array","items":{"type":"string","enum":["EXPECTED","PENDING","COMPLETED","CANCELLED","FAILED"]}}},{"name":"transactionAccountIncludeTypes","required":false,"in":"query","description":"Filter transactions by their account include type (e.g., Customer account, Program account). Multiple values allowed.","example":["CUSTOMER_ACCOUNT","PROGRAM_ACCOUNT"],"schema":{"nullable":true,"default":["CUSTOMER_ACCOUNT","PROGRAM_ACCOUNT"],"type":"array","items":{"type":"string","enum":["CUSTOMER_ACCOUNT","PROGRAM_ACCOUNT"]}}},{"name":"page","required":true,"in":"query","description":"Page number for paginated results. Starts from 1.","example":1,"schema":{"default":1,"type":"number"}},{"name":"limit","required":true,"in":"query","description":"Number of transactions per page. Maximum allowed value is 100.","example":10,"schema":{"maximum":100,"default":10,"type":"number"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"List of transactions","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Pagination"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PartnerTransactionResponse"}},"meta":{"type":"object","properties":{"currentPage":{"type":"number","example":1},"itemCount":{"type":"number","example":10},"itemsPerPage":{"type":"number","example":10},"totalItems":{"type":"number","example":100},"totalPages":{"type":"number","example":10}}}}}]}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Transactions"]}},"/v1/partner/transactions/{transactionId}":{"get":{"operationId":"TransactionController_getTransaction","summary":"Get transaction","parameters":[{"name":"transactionId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Transaction detail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerTransactionResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Transaction not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Transactions"]}},"/v1/partner/payment-simulation/customers/{customerId}/simulate-inbound-payment":{"post":{"operationId":"PaymentSimulationController_simulateInboundPayment","summary":"Simulate payment using customer","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSimulateInboundPaymentPayload"}}}},"responses":{"201":{"description":"Simulate payment"},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Payment Simulations"]}},"/v1/partner/payment-simulation/account/simulate-inbound-payment":{"post":{"operationId":"PaymentSimulationController_simulateInboundPaymentForAccount","summary":"Simulate payment using account","parameters":[{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSimulateInboundPaymentPayload"}}}},"responses":{"201":{"description":"Simulate payment"},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"408":{"description":"Request timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"503":{"description":"Service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Payment Simulations"]}},"/v1/partner/payment-simulation/customers/{customerId}/simulate-direct-debit-mandate":{"post":{"operationId":"PaymentSimulationController_simulateDirectDebitMandate","summary":"Simulate direct debit mandate","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSimulateDirectDebitMandateRequest"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerAutomatedPaymentResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"412":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Payment Simulations"]}},"/v1/partner/payment-simulation/customers/{customerId}/simulate-direct-debit-payment":{"post":{"operationId":"PaymentSimulationController_simulateDirectDebitPayment","summary":"Simulate direct debit payment","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSimulateDirectDebitPaymentRequest"}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"408":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Payment Simulations"]}},"/v1/partner/payment-simulation/customers/{customerId}/simulate-direct-credit-payment":{"post":{"operationId":"PaymentSimulationController_simulateDirectCreditPayment","summary":"Simulate direct credit payment","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSimulateDirectCreditPaymentRequest"}}}},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"408":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"503":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Payment Simulations"]}},"/v1/partner/prospects/personal":{"get":{"operationId":"PersonalProspectController_getPersonalProspects","summary":"List personal prospects","parameters":[{"name":"states","required":false,"in":"query","description":"List of prospects states to filter prospects. When omitted, prospects in any state are returned.","example":["IDLE"],"schema":{"nullable":true,"type":"array","items":{"type":"string","enum":["IDLE","VERIFICATION_PENDING","PROVIDING_KYC_DATA","AWAITING_QUESTIONNAIRE","COLLECT_DOCS","UNDER_REVIEW","AWAITING_KYC_RESULT","KYC_FAILED","AWAITING_CUSTOMER_CREATION","ONBOARDED","ONBOARDING_FAILED","DUPLICATE_KYC_DATA","REJECTED","UNKNOWN"]}}},{"name":"searchKeyword","required":false,"in":"query","description":"Search in names and emails.","schema":{"nullable":true,"type":"string"}},{"name":"page","required":true,"in":"query","description":"Page number for paginated results.","example":1,"schema":{"default":1,"type":"number"}},{"name":"limit","required":true,"in":"query","description":"Number of prospects per page.","example":10,"schema":{"maximum":100,"default":10,"type":"number"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"List of personal prospects available to the partner","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Pagination"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PartnerPersonalProspectResponse"}},"meta":{"type":"object","properties":{"currentPage":{"type":"number","example":1},"itemCount":{"type":"number","example":10},"itemsPerPage":{"type":"number","example":10},"totalItems":{"type":"number","example":100},"totalPages":{"type":"number","example":10}}}}}]}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Onboarding Prospects - Personal"]},"post":{"operationId":"PersonalProspectController_createPersonalProspect","summary":"Create personal prospect","parameters":[{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCreatePersonalProspectRequest"}}}},"responses":{"201":{"description":"Creates a personal prospect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPersonalProspectDetailedResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Onboarding Prospects - Personal"]}},"/v1/partner/prospects/personal/externalReference/{externalReference}":{"get":{"operationId":"PersonalProspectController_getPersonalProspectByExternalId","summary":"Get personal prospect by externalId","parameters":[{"name":"externalReference","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Get personal prospects by externalId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPersonalProspectDetailedResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Prospect not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Onboarding Prospects - Personal"]}},"/v1/partner/prospects/personal/{prospectId}":{"patch":{"operationId":"PersonalProspectController_updatePersonalProspect","summary":"Update personal prospect partially","parameters":[{"name":"prospectId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerUpdatePersonalProspectRequest"}}}},"responses":{"200":{"description":"Updates a personal prospect partially.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPersonalProspectDetailedResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Onboarding Prospects - Personal"]},"get":{"operationId":"PersonalProspectController_getPersonalProspectById","summary":"Get personal prospect by id","parameters":[{"name":"prospectId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Get personal prospects by id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPersonalProspectDetailedResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Prospect not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Onboarding Prospects - Personal"]}},"/v1/partner/prospects/personal/questionnaire":{"get":{"operationId":"PersonalProspectControllerDeprecated_getQuestionnaire","summary":"","deprecated":true,"description":"Will be removed","parameters":[{"name":"customerId","required":true,"in":"query","schema":{"type":"string"}},{"name":"sourceId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}}},"post":{"operationId":"PersonalProspectControllerDeprecated_submitQuestionnaire","summary":"","deprecated":true,"description":"Will be removed","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerQuestionnaireQuestionAnswerRequest"}}}},"responses":{"201":{"description":""}}}},"/v1/partner/prospects/personal/compliance/{prospectId}/start-checks":{"post":{"operationId":"PersonalProspectControllerDeprecated_startComplianceChecks","summary":"","deprecated":true,"description":"Will be removed","parameters":[{"name":"prospectId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerStartPersonalComplianceChecksRequest"}}}},"responses":{"201":{"description":""}}}},"/v1/partner/prospects/business":{"get":{"operationId":"BusinessProspectController_getBusinessProspects","summary":"Get business prospects","parameters":[{"name":"states","required":false,"in":"query","description":"List of prospects states to filter prospects. When omitted, prospects in any state are returned.","example":["IDLE"],"schema":{"nullable":true,"type":"array","items":{"type":"string","enum":["IDLE","VERIFICATION_PENDING","PROVIDING_KYC_DATA","AWAITING_QUESTIONNAIRE","COLLECT_DOCS","UNDER_REVIEW","AWAITING_KYC_RESULT","KYC_FAILED","AWAITING_CUSTOMER_CREATION","ONBOARDED","ONBOARDING_FAILED","DUPLICATE_KYC_DATA","REJECTED","UNKNOWN"]}}},{"name":"searchKeyword","required":false,"in":"query","description":"Search in names and emails.","schema":{"nullable":true,"type":"string"}},{"name":"page","required":true,"in":"query","description":"Page number for paginated results.","example":1,"schema":{"default":1,"type":"number"}},{"name":"limit","required":true,"in":"query","description":"Number of prospects per page.","example":10,"schema":{"maximum":100,"default":10,"type":"number"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"List of business prospects available to the partner","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Pagination"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PartnerBusinessProspectResponse"}},"meta":{"type":"object","properties":{"currentPage":{"type":"number","example":1},"itemCount":{"type":"number","example":10},"itemsPerPage":{"type":"number","example":10},"totalItems":{"type":"number","example":100},"totalPages":{"type":"number","example":10}}}}}]}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Onboarding Prospects - Business"]},"post":{"operationId":"BusinessProspectController_createBusinessProspect","summary":"Create business prospect","parameters":[{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCreateBusinessProspectRequest"}}}},"responses":{"201":{"description":"Creates a business prospect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerBusinessProspectDetailedResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Onboarding Prospects - Business"]}},"/v1/partner/prospects/business/externalReference/{externalReference}":{"get":{"operationId":"BusinessProspectController_getBusinessProspectByExternalId","summary":"Get business prospect by externalId","parameters":[{"name":"externalReference","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Get business prospects by externalId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerBusinessProspectDetailedResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Prospect not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Onboarding Prospects - Business"]}},"/v1/partner/prospects/business/{prospectId}":{"patch":{"operationId":"BusinessProspectController_updateBusinessProspect","summary":"Update business prospect partially","parameters":[{"name":"prospectId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerUpdateBusinessProspectRequest"}}}},"responses":{"200":{"description":"Updates a business prospect partially.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerBusinessProspectDetailedResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Onboarding Prospects - Business"]},"get":{"operationId":"BusinessProspectController_getBusinessProspectById","summary":"Get business prospect by id","parameters":[{"name":"prospectId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Get business prospects by id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerBusinessProspectDetailedResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"404":{"description":"Prospect not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Onboarding Prospects - Business"]}},"/v1/partner/compliance/due-diligence/questionnaire":{"get":{"operationId":"DueDiligenceController_getQuestionnaire","summary":"Get questionnaire for a applicant","description":"Retrieves the compliance questionnaire associated with applicant. Fails if the applicant is not ready for questionnaire.","parameters":[{"name":"entityId","required":true,"in":"query","description":"Unique entity identifier (prospectId or customerId)","schema":{"type":"string"}},{"name":"sourceId","required":false,"in":"query","description":"Source Id of the questionnaire","schema":{"type":"string"}},{"name":"source","required":false,"in":"query","description":"Source of the questionnaire","schema":{"enum":["NONE","ONBOARDING","PERIODIC_REVIEW","CUSTOMER_TASK"],"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Questionnaire successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerQuestionnaireResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"406":{"description":"Applicant not ready for questionnaire","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Compliance"]},"post":{"operationId":"DueDiligenceController_submitQuestionnaire","summary":"Submit questionnaire for applicant","description":"Retrieves the compliance questionnaire associated with applicant. Fails if the applicant is not ready for questionnaire.","parameters":[{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerQuestionnaireQuestionAnswerRequest"}}}},"responses":{"200":{"description":"Questionnaire successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerQuestionnaireResponse"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"406":{"description":"Applicant not ready for questionnaire","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Compliance"]}},"/v1/partner/compliance/due-diligence/{prospectId}/upload-evidence/{externalEvidenceId}":{"post":{"operationId":"DueDiligenceController_uploadEvidence","summary":"Upload evidence file","parameters":[{"name":"prospectId","required":true,"in":"path","schema":{"type":"string"}},{"name":"externalEvidenceId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"Upload evidence file."},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Compliance"]}},"/v1/partner/compliance/due-diligence/{prospectId}/onboarding-checks":{"get":{"operationId":"DueDiligenceController_getOnboardingChecks","summary":"Get compliance checks details for personal prospect","parameters":[{"name":"prospectId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"responses":{"200":{"description":"Start compliance checks for personal prospect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerPersonalProspectDueDiligenceInfo"}}}},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Compliance"]}},"/v1/partner/compliance/due-diligence/{prospectId}/start-onboarding-checks":{"post":{"operationId":"DueDiligenceController_startComplianceChecks","summary":"Start compliance checks personal prospect","parameters":[{"name":"prospectId","required":true,"in":"path","schema":{"type":"string"}},{"name":"authorization","in":"header","description":"Authorization header containing your API Token","schema":{"type":"string"}},{"name":"x-alg-nonce","in":"header","description":"Nonce used to generate the payload signature","schema":{"type":"string"}},{"name":"x-alg-signature","in":"header","description":"Payload signature","schema":{"type":"string"}},{"name":"date","in":"header","description":"Date of the request un UTC/GMT","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerStartPersonalComplianceChecksRequest"}}}},"responses":{"200":{"description":"Start compliance checks for personal prospect."},"400":{"description":"Input validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCommonErrorResponse"}}}}},"tags":["Compliance"]}}},"info":{"title":"Horizon Link - API Docs","description":"","version":"1.0","contact":{}},"tags":[],"servers":[{"url":"api-url"}],"components":{"schemas":{"PartnerTestRequest":{"type":"object","properties":{"message":{"type":"string","format":"string","maximum":100,"example":"Hello"}},"required":["message"]},"PartnerCreatePrimaryAccountRequest":{"type":"object","properties":{"customerId":{"type":"string","description":"Customer ID that will be the account owner.","example":"a2b9649e-df7f-4349-adff-1c57283fef10","format":"uuid"},"idempotencyKey":{"type":"string","description":"A unique idempotency key to prevent duplicate account creation.","example":"1483d25d-3f00-4d39-90ce-2379a130becd","format":"uuid"},"currencyCode":{"type":"string","description":"ISO 4217 3-letter alpha-numeric currency code for the account.","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP"},"productCode":{"type":"string","description":"The product code for the account being created.","example":"FIAT_ACCOUNT_UK_V1"}},"required":["customerId","idempotencyKey","currencyCode","productCode"]},"PartnerUKAccount":{"type":"object","properties":{"sortCode":{"type":"string","description":"UK domestic bank sort code","example":"010102"},"accountNumber":{"type":"string","description":"UK domestic bank account number","example":"12345678"},"type":{"type":"object","description":"Type of the account","example":"UK_ACCOUNT"}},"required":["sortCode","accountNumber","type"]},"PartnerIBANAccount":{"type":"object","properties":{"iban":{"type":"string","description":"International Bank Account Number (IBAN)","example":"GB33BUKB20201555555555"},"bic":{"type":"string","description":"Bank Identifier Code (BIC)","example":"BUKBGB22"},"currency":{"type":"string","description":"Currency of the account","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP"},"country":{"type":"string","description":"Country of the account","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"],"example":"GBR"},"type":{"type":"object","description":"Type of the account","example":"IBAN"}},"required":["iban","bic","currency","country","type"]},"PartnerCustodyIdAccount":{"type":"object","properties":{"id":{"type":"string","description":"External identifier","example":"A0000EXTM"},"type":{"type":"object","description":"Type of the account","example":"CUSTODY_ID"}},"required":["id","type"]},"PartnerOtherExternalAccount":{"type":"object","properties":{"bic":{"type":"string","description":"Bank Identifier Code (BIC)","example":"BUKBGB22","nullable":true},"country":{"type":"string","description":"Country of the account","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"],"example":"GBR","nullable":true},"currency":{"type":"string","description":"Currency of the account","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP"},"descriptor":{"type":"string","description":"Descriptor of the account","example":"AMERICAN INTERNATIONAL GROUP UK LTD"},"type":{"type":"object","description":"Type of the account","example":"OTHER_EXTERNAL"}},"required":["currency","descriptor","type"]},"PartnerGenericAccount":{"type":"object","properties":{"type":{"type":"object","description":"Type of the account","example":"GENERIC_ACCOUNT"},"accountNumber":{"type":"string","description":"Generic bank account number","example":"000123456789"},"routingType":{"type":"string","description":"Type of the routing","example":"BANK_CODE","enum":["ROUTING_CODE","GIRO_ROUTING_CODE","ACH_ROUTING_NUMBER","FAST_ROUTING_CODE","WIRE_ROUTING_NUMBER","MEPS_ROUTING_CODE","ABA_ROUTING_NUMBER","BANK_CODE","BRANCH_CODE","BSB_CODE","CLABE","CNAPS","IFSC","INSTITUTION_NO"]},"routingNumber":{"type":"string","description":"Generic routing number","example":"021000021"},"secondaryRoutingType":{"type":"string","description":"Type of the routing","example":"BRANCH_CODE","nullable":true,"enum":["ROUTING_CODE","GIRO_ROUTING_CODE","ACH_ROUTING_NUMBER","FAST_ROUTING_CODE","WIRE_ROUTING_NUMBER","MEPS_ROUTING_CODE","ABA_ROUTING_NUMBER","BANK_CODE","BRANCH_CODE","BSB_CODE","CLABE","CNAPS","IFSC","INSTITUTION_NO"]},"secondaryRoutingNumber":{"type":"string","description":"Secondary routing number","example":"021000021","nullable":true},"currency":{"type":"object","description":"Currency code of the account","example":"CAD"},"country":{"type":"object","description":"Country code of the account","example":"CAN"},"bic":{"type":"string","description":"Bic of the account","example":"BOFAUS3N"}},"required":["type","accountNumber","routingType","routingNumber","secondaryRoutingType","secondaryRoutingNumber","currency","country","bic"]},"PartnerAccountIdentifierResponse":{"type":"object","properties":{"type":{"type":"string","enum":["UK_ACCOUNT","IBAN","CUSTODY_ID","OTHER_EXTERNAL","GENERIC_ACCOUNT"],"example":"UK_ACCOUNT"},"beneficiary":{"type":"string","description":"Beneficiary name","example":"John Doe"},"bankAddress":{"type":"string","description":"Bank address","example":"Threadneedle St, London EC2R 8AH, United Kingdom"},"bankName":{"type":"string","description":"Name of the bank issuing the account identifier","example":"Barclays Bank PLC"},"data":{"description":"Identifiers including Account Number and Sort Code for UK accounts, IBAN for international accounts, or ACH details for US accounts","oneOf":[{"$ref":"#/components/schemas/PartnerUKAccount"},{"$ref":"#/components/schemas/PartnerIBANAccount"},{"$ref":"#/components/schemas/PartnerCustodyIdAccount"},{"$ref":"#/components/schemas/PartnerOtherExternalAccount"},{"$ref":"#/components/schemas/PartnerGenericAccount"}],"examples":[{"type":"UK_ACCOUNT","sortCode":"010102","accountNumber":"12345678"},{"type":"IBAN","iban":"GB33BUKB20201555555555","bic":"BUKBGB22","currency":"GBP","country":"GBR"},{"type":"CUSTODY_ID","id":"A0000EXTM"},{"type":"OTHER_EXTERNAL","bic":"BUKBGB22","currency":"GBP","country":"GBR","descriptor":"AMERICAN INTERNATIONAL GROUP UK LTD"},{"type":"GENERIC_ACCOUNT","routingType":"ACH_ROUTING_NUMBER","routingNumber":"021000021","accountNumber":"000123456789","country":"USA","currency":"USD"}]}},"required":["type","beneficiary","bankAddress","data"]},"PartnerAccountBalanceResponse":{"type":"object","properties":{"currency":{"type":"string","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP"},"availableBalance":{"type":"number"},"ledgerBalance":{"type":"number"},"pendingCredits":{"type":"number"}},"required":["currency","availableBalance","ledgerBalance","pendingCredits"]},"PartnerPrimaryAccountResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the account","example":"e0cab2dd-739f-43de-b131-3e423e935bf1"},"partnerId":{"type":"string","format":"uuid","description":"Partner identifier that owns or manages this account","example":"2ecf0e23-3215-462c-97c4-9e5a147656d7","deprecated":true},"externalReference":{"type":"string","format":"uuid","description":"External reference"},"primaryAccountId":{"type":"string","nullable":true,"format":"uuid","description":"Always null for primary accounts","example":null},"currencyCode":{"type":"string","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP","description":"Currency associated with this account"},"createDate":{"format":"date-time","type":"string","description":"Date when the account was created","example":"2025-01-01"},"identifiers":{"description":"List of identifiers linked to this account","type":"array","items":{"$ref":"#/components/schemas/PartnerAccountIdentifierResponse"}},"state":{"type":"string","enum":["INITIALIZING","READY","BLOCKED","CLOSED","SUSPENDED"],"description":"Current operational state of the account","example":"READY"},"balance":{"description":"Balance details of the account","allOf":[{"$ref":"#/components/schemas/PartnerAccountBalanceResponse"}]},"type":{"type":"string","enum":["PRIMARY","VIRTUAL","PROGRAM"],"example":"PRIMARY","description":"Type of account"},"customerId":{"type":"string","format":"uuid","description":"Customer identifier associated with this account","example":"a2b9649e-df7f-4349-adff-1c57283fef10"}},"required":["id","partnerId","currencyCode","createDate","identifiers","state","balance","type","customerId"]},"PartnerValidationFieldError":{"type":"object","properties":{"message":{"type":"string"},"path":{"type":"string","nullable":true}},"required":["message"]},"PartnerCommonErrorResponse":{"type":"object","properties":{"errorType":{"type":"string","enum":["VALIDATION_ERROR","FORBIDDEN","NOT_FOUND","UNAUTHORIZED","PRECONDITION_FAILED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE","UNIDENTIFIED","TECHNICAL_ERROR"]},"reason":{"type":"string","nullable":true},"validationFailures":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/PartnerValidationFieldError"}}},"required":["errorType"]},"PartnerCreateVirtualAccountRequest":{"type":"object","properties":{"customerId":{"type":"string","description":"Customer ID that will be the account owner.","example":"a2b9649e-df7f-4349-adff-1c57283fef10","format":"uuid"},"idempotencyKey":{"type":"string","description":"A unique idempotency key to prevent duplicate account creation.","example":"1483d25d-3f00-4d39-90ce-2379a130becd","format":"uuid"},"externalReference":{"type":"string","description":"Reference identifier provided by partner.","example":"ae588135-0391-42a8-a4e4-e8e7645fa707","format":"uuid","nullable":true},"parentAccountId":{"type":"string","description":"The parent account ID under which the virtual account will be created.","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid"},"productCode":{"type":"string","description":"The product code for the virtual account being created.","example":"FIAT_ACCOUNT_UK_V1"},"productParameters":{"type":"object","description":"Product parameters for the virtual account being created.","nullable":true}},"required":["customerId","idempotencyKey","parentAccountId","productCode"]},"PartnerVirtualAccountResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the account","example":"e0cab2dd-739f-43de-b131-3e423e935bf1"},"partnerId":{"type":"string","format":"uuid","description":"Partner identifier that owns or manages this account","example":"2ecf0e23-3215-462c-97c4-9e5a147656d7","deprecated":true},"externalReference":{"type":"string","format":"uuid","description":"External reference"},"primaryAccountId":{"type":"string","nullable":true,"format":"uuid","description":"Primary account identifier","example":"ae66fcb2-2852-4568-990d-accc78572e4d"},"currencyCode":{"type":"string","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP","description":"Currency associated with this account"},"createDate":{"format":"date-time","type":"string","description":"Date when the account was created","example":"2025-01-01"},"identifiers":{"description":"List of identifiers linked to this account","type":"array","items":{"$ref":"#/components/schemas/PartnerAccountIdentifierResponse"}},"state":{"type":"string","enum":["INITIALIZING","READY","BLOCKED","CLOSED","SUSPENDED"],"description":"Current operational state of the account","example":"READY"},"balance":{"description":"Balance details of the account","allOf":[{"$ref":"#/components/schemas/PartnerAccountBalanceResponse"}]},"type":{"type":"string","enum":["PRIMARY","VIRTUAL","PROGRAM"],"example":"VIRTUAL","description":"Type of account"},"customerId":{"type":"string","format":"uuid","description":"Customer identifier associated with this account","example":"a2b9649e-df7f-4349-adff-1c57283fef10"},"productCode":{"type":"string","description":"The product code for the virtual account","enum":["CUBE_BASIC_SAVING","CUBE_EARNING","PRIMARY_RINGFENCE"],"example":"CUBE_BASIC_SAVING"}},"required":["id","partnerId","currencyCode","createDate","identifiers","state","balance","type","customerId","productCode"]},"PartnerAccountErrorResponse":{"type":"object","properties":{"errorType":{"type":"string","enum":["ACCOUNT_NOT_AVAILABLE"]},"reason":{"type":"string","nullable":true},"validationFailures":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/PartnerValidationFieldError"}}},"required":["errorType"]},"Pagination":{"type":"object","properties":{}},"PartnerProgramAccountResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the account","example":"e0cab2dd-739f-43de-b131-3e423e935bf1"},"partnerId":{"type":"string","format":"uuid","description":"Partner identifier that owns or manages this account","example":"2ecf0e23-3215-462c-97c4-9e5a147656d7","deprecated":true},"externalReference":{"type":"string","format":"uuid","description":"External reference"},"primaryAccountId":{"type":"string","nullable":true,"format":"uuid","description":"Always null for program accounts","example":null},"currencyCode":{"type":"string","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP","description":"Currency associated with this account"},"createDate":{"format":"date-time","type":"string","description":"Date when the account was created","example":"2025-01-01"},"identifiers":{"description":"List of identifiers linked to this account","type":"array","items":{"$ref":"#/components/schemas/PartnerAccountIdentifierResponse"}},"state":{"type":"string","enum":["INITIALIZING","READY","BLOCKED","CLOSED","SUSPENDED"],"description":"Current operational state of the account","example":"READY"},"balance":{"description":"Balance details of the account","allOf":[{"$ref":"#/components/schemas/PartnerAccountBalanceResponse"}]},"type":{"type":"string","enum":["PRIMARY","VIRTUAL","PROGRAM"],"example":"PROGRAM","description":"Type of account"}},"required":["id","partnerId","currencyCode","createDate","identifiers","state","balance","type"]},"PartnerDeleteVirtualAccountRequest":{"type":"object","properties":{"idempotencyKey":{"type":"string","format":"uuid","description":"A unique idempotency key to prevent duplicate operations"},"requestedBy":{"type":"string"},"reason":{"type":"string"},"notes":{"type":"string","nullable":true}},"required":["idempotencyKey","requestedBy","reason","notes"]},"PartnerPersonalDetailsPayload":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the counterparty.","example":"John","maxLength":70},"lastName":{"type":"string","description":"Last name of the counterparty.","example":"Doe","maxLength":70}},"required":["firstName","lastName"]},"PartnerBusinessDetailsPayload":{"type":"object","properties":{"businessName":{"type":"string","description":"Registered legal name of the business partner","example":"Algbra U.K. Ltd","maxLength":140}},"required":["businessName"]},"PartnerUnknownDetailsPayload":{"type":"object","properties":{"name":{"type":"string","description":"Name of the counterparty","example":"OperatingAcc","maxLength":140}},"required":["name"]},"PartnerPaymentDomesticCounterpartyPayload":{"type":"object","properties":{"sortCode":{"type":"string","description":"UK domestic bank sort code.","example":"010102"},"accountNumber":{"type":"string","description":"UK domestic bank account number.","example":"12345678"}},"required":["sortCode","accountNumber"]},"PartnerPaymentIBANCounterpartyPayload":{"type":"object","properties":{"iban":{"type":"string","description":"International Bank Account Number (IBAN).","example":"GB33BUKB20201555555555"},"bic":{"type":"string","description":"Bank Identifier Code (BIC).","example":"BUKBGB22","nullable":true},"currency":{"type":"string","description":"Currency of the counterparty account.","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP"},"country":{"type":"string","description":"Country of the counterparty account.","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"],"example":"GBR"}},"required":["iban","currency","country"]},"PartnerPaymentCustodyIdCounterpartyPayload":{"type":"object","properties":{"id":{"type":"string","description":"External identifier","example":"A0000EXTM"}},"required":["id"]},"PartnerPaymentOtherExternalCounterpartyPayload":{"type":"object","properties":{"descriptor":{"type":"string","description":"Descriptor of the account.","example":"AMERICAN INTERNATIONAL GROUP UK LTD"},"bic":{"type":"string","description":"Bank Identifier Code (BIC).","example":"BUKBGB22","nullable":true},"currency":{"type":"string","description":"Currency of the counterparty account.","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP"},"country":{"type":"string","description":"Country of the counterparty account.","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"],"example":"GBR","nullable":true}},"required":["descriptor","currency"]},"PartnerPaymentGenericAccountCounterpartyPayload":{"type":"object","properties":{"accountNumber":{"type":"string","description":"Account number (required unless routingType is CLABE)","example":"1234567890","nullable":true},"routingType":{"type":"string","description":"Primary routing type (required when BIC is not provided)","enum":["ROUTING_CODE","GIRO_ROUTING_CODE","ACH_ROUTING_NUMBER","FAST_ROUTING_CODE","WIRE_ROUTING_NUMBER","MEPS_ROUTING_CODE","ABA_ROUTING_NUMBER","BANK_CODE","BRANCH_CODE","BSB_CODE","CLABE","CNAPS","IFSC","INSTITUTION_NO"],"example":"ABA_ROUTING_NUMBER","nullable":true},"routingNumber":{"type":"string","description":"Primary routing number (required when routingType is provided)","example":"026009593","nullable":true},"secondaryRoutingType":{"type":"string","description":"Secondary routing type","enum":["ROUTING_CODE","GIRO_ROUTING_CODE","ACH_ROUTING_NUMBER","FAST_ROUTING_CODE","WIRE_ROUTING_NUMBER","MEPS_ROUTING_CODE","ABA_ROUTING_NUMBER","BANK_CODE","BRANCH_CODE","BSB_CODE","CLABE","CNAPS","IFSC","INSTITUTION_NO"],"example":"ROUTING_CODE","nullable":true},"secondaryRoutingNumber":{"type":"string","description":"Secondary routing number (required when secondaryRoutingType is provided)","example":"GB33BUKB20201555555555","nullable":true},"bic":{"type":"string","description":"Bank Identifier Code (required when routingType is not provided)","example":"BUKBGB22","nullable":true},"currency":{"type":"string","description":"Currency of the counterparty account.","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP"},"country":{"type":"string","description":"Country of the counterparty account.","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"],"example":"GBR"}},"required":["currency","country"]},"PartnerAutomatedPaymentCounterpartyResponse":{"type":"object","properties":{"type":{"type":"string","enum":["BUSINESS","PERSONAL","UNKNOWN"],"description":"Type of the automated payment counterparty."},"details":{"description":"Counterparty identity details. Shape depends on the counterparty type.","oneOf":[{"$ref":"#/components/schemas/PartnerPersonalDetailsPayload"},{"$ref":"#/components/schemas/PartnerBusinessDetailsPayload"},{"$ref":"#/components/schemas/PartnerUnknownDetailsPayload"}]},"accountCurrency":{"type":"string","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"description":"Currency of the counterparty account."},"accountReferenceType":{"type":"string","enum":["UK_ACCOUNT","IBAN","CUSTODY_ID","OTHER_EXTERNAL","GENERIC_ACCOUNT"],"description":"Type of account reference supplied for the counterparty."},"accountReference":{"description":"Counterparty account reference details. Shape depends on the account reference type.","oneOf":[{"$ref":"#/components/schemas/PartnerPaymentDomesticCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentIBANCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentCustodyIdCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentOtherExternalCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentGenericAccountCounterpartyPayload"}]}},"required":["type","details","accountCurrency","accountReferenceType","accountReference"]},"PartnerAutomatedPaymentCounterpartyMetadataResponse":{"type":"object","properties":{"serviceUserNumber":{"type":"string","description":"BACS service user number associated with the direct debit originator."},"name":{"type":"string","nullable":true,"description":"Originator display name associated with the automated payment."},"logo":{"type":"string","nullable":true,"description":"Optional logo URL resolved for the automated payment counterparty."},"category":{"type":"string","enum":["GENERAL","SHOPPING","TRANSFERS","EATING_OUT","DONATIONS","FAMILY","CASH","ENTERTAINMENT","EXPENSES","GIFTS","GROCERIES","HOLIDAYS","INVESTMENTS","PERSONAL_CARE","SALARY","SAVINGS","SERVICES","TRANSPORT","UTILITIES","CASHBACK_REWARDS","REFERRAL_REWARDS"],"nullable":true,"description":"Optional transaction category inferred for the automated payment counterparty."}},"required":["serviceUserNumber"]},"PartnerAutomatedPaymentPayerResponse":{"type":"object","properties":{"accountName":{"type":"string","nullable":true,"description":"Payer account name provided to the originator when the direct debit mandate was set up.","example":"J SMITH"},"sortCode":{"type":"string","nullable":true,"description":"Sort code of the payer account debited by the automated payment.","example":"040000"},"accountNumber":{"type":"string","nullable":true,"description":"Account number of the payer account debited by the automated payment.","example":"12345678"}}},"PartnerAutomatedPaymentResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the automated payment."},"type":{"type":"string","enum":["DIRECT_DEBIT"],"description":"Type of automated payment."},"customerId":{"type":"string","format":"uuid","nullable":true,"description":"Identifier of the customer that owns the automated payment."},"accountId":{"type":"string","format":"uuid","description":"Identifier of the customer's account linked to the automated payment."},"reference":{"type":"string","nullable":true,"description":"Partner reference associated with the automated payment instruction."},"amount":{"type":"number","nullable":true,"description":"Amount configured for the automated payment, when available."},"state":{"type":"string","enum":["IDLE","INITIATION_PENDING","INITIATED","CANCELLATION_PENDING","CANCELLED"],"description":"Current lifecycle state of the automated payment."},"reasonCode":{"type":"string","nullable":true,"description":"Reason code associated with the current state, when available. `PAYER_NAME_MISMATCH` indicates the mandate was cancelled because the payer name did not match the account holder."},"createdOn":{"format":"date-time","type":"string","description":"Timestamp when the automated payment was created."},"updatedOn":{"format":"date-time","type":"string","description":"Timestamp when the automated payment was last updated."},"counterparty":{"description":"Counterparty linked to the automated payment instruction.","allOf":[{"$ref":"#/components/schemas/PartnerAutomatedPaymentCounterpartyResponse"}]},"metadata":{"description":"Partner-safe metadata associated with the automated payment counterparty.","allOf":[{"$ref":"#/components/schemas/PartnerAutomatedPaymentCounterpartyMetadataResponse"}]},"payer":{"nullable":true,"description":"Payer account details reported when the automated payment was set up, when available.","allOf":[{"$ref":"#/components/schemas/PartnerAutomatedPaymentPayerResponse"}]}},"required":["id","type","accountId","state","createdOn","updatedOn","counterparty","metadata"]},"PartnerAutomatedPaymentStateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the automated payment state record."},"state":{"type":"string","enum":["IDLE","INITIATION_PENDING","INITIATED","CANCELLATION_PENDING","CANCELLED"],"description":"Lifecycle state recorded for the automated payment."},"createdOn":{"format":"date-time","type":"string","description":"Timestamp when this automated payment state was recorded."},"automatedPaymentId":{"type":"string","format":"uuid","description":"Identifier of the automated payment this state belongs to."},"reasonCode":{"type":"string","nullable":true,"description":"Optional reason code associated with this state transition."}},"required":["id","state","createdOn","automatedPaymentId"]},"PartnerRevokeAutomatedPaymentRequest":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["INSTITUTION_CANCELLED_REFER_TO_PAYER","CANCELLED_BY_PAYER","PAYER_DECEASED","ACCOUNT_CLOSED"],"description":"Reason code explaining why the automated payment should be revoked."},"idempotencyKey":{"type":"string","format":"uuid","description":"Unique idempotency key to prevent duplicate revoke requests."}},"required":["reasonCode","idempotencyKey"]},"PartnerPaymentAddressPayload":{"type":"object","properties":{"buildingName":{"type":"string","description":"Building name","example":"Eiffel Tower","nullable":true},"buildingNumber":{"type":"string","description":"Building number","example":"10","nullable":true},"state":{"type":"string","description":"State / region","example":"Île-de-France","nullable":true},"street":{"type":"string","description":"Street / address line","example":"Av. Gustave Eiffel","nullable":true},"town":{"type":"string","description":"Town / city","example":"Paris"},"postcode":{"type":"string","description":"Postal / ZIP code","example":"75007"},"country":{"type":"string","description":"Country code","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"],"example":"FRA"}},"required":["town","postcode","country"]},"PartnerPaymentReferenceCounterpartyPayload":{"type":"object","properties":{"type":{"type":"string","description":"Type of counterparty","enum":["BUSINESS","PERSONAL","UNKNOWN"],"example":"PERSONAL"},"details":{"description":"Counterparty details varies on type","example":{"firstName":"John","lastName":"Doe"},"oneOf":[{"$ref":"#/components/schemas/PartnerPersonalDetailsPayload"},{"$ref":"#/components/schemas/PartnerBusinessDetailsPayload"},{"$ref":"#/components/schemas/PartnerUnknownDetailsPayload"}]},"accountCurrency":{"type":"string","description":"Currency of the counterparty account.","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP"},"accountReferenceType":{"type":"string","description":"Type of account reference used for the counterparty.","enum":["UK_ACCOUNT","IBAN","CUSTODY_ID","OTHER_EXTERNAL","GENERIC_ACCOUNT"],"example":"UK_ACCOUNT"},"accountReference":{"description":"Details of the account reference. Format varies depending on reference type.","examples":[{"sortCode":"010102","accountNumber":"12345678"},{"iban":"GB33BUKB20201555555555","bic":"BUKBGB22","currency":"GBP","country":"GBR"},{"id":"A0000EXTM"},{"bic":"BUKBGB22","currency":"GBP","country":"GBR","descriptor":"AMERICAN INTERNATIONAL GROUP UK LTD"},{"accountNumber":"1234567890","routingType":"ABA_ROUTING_NUMBER","routingNumber":"026009593","bic":"BUKBGB22","currency":"GBP","country":"GBR"}],"oneOf":[{"$ref":"#/components/schemas/PartnerPaymentDomesticCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentIBANCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentCustodyIdCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentOtherExternalCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentGenericAccountCounterpartyPayload"}]},"address":{"description":"Counterparty address (required when accountReferenceType is IBAN or GENERIC_ACCOUNT)","nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerPaymentAddressPayload"}]}},"required":["type","details","accountCurrency","accountReferenceType","accountReference"]},"PartnerPaymentAccountIdCounterpartyPayload":{"type":"object","properties":{"type":{"type":"string","description":"Type of counterparty","enum":["BUSINESS","PERSONAL","UNKNOWN"],"example":"PERSONAL"},"accountCurrency":{"type":"string","description":"Currency of the counterparty account.","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP"},"accountId":{"type":"string","description":"Id of the account","example":"e0cab2dd-739f-43de-b131-3e423e935bf1"},"address":{"description":"Counterparty address","nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerPaymentAddressPayload"}]}},"required":["type","accountCurrency","accountId"]},"PartnerCardTransactionScheme":{"type":"object","properties":{"network":{"type":"string","description":"Network name (e.g., MasterCard, Visa)","example":"MasterCard"},"binPrefix":{"type":"string","description":"Bank Identification Number prefix","example":"5432"},"referenceId":{"type":"string","description":"Reference identifier for the scheme","example":"ref123"}}},"PartnerCardTransactionAcceptor":{"type":"object","properties":{"networkMid":{"type":"string","description":"Network merchant identifier","example":"NETWORK_MID_123"},"mccGroups":{"description":"Merchant category code groups","example":["5411","5499"],"type":"array","items":{"type":"string"}},"mid":{"type":"string","description":"Merchant identifier","example":"MID123456"},"mcc":{"type":"string","description":"Merchant category code","example":"5411"},"name":{"type":"string","description":"Merchant name","example":"Supermarket"},"address":{"type":"string","description":"Merchant address","example":"123 Main Street"},"city":{"type":"string","description":"Merchant city","example":"London"},"state":{"type":"string","description":"Merchant state or province","example":"Greater London"},"postcode":{"type":"string","description":"Merchant postal code","example":"SW1A 1AA"},"country":{"type":"string","description":"Merchant country code (ISO 3166-1 alpha-2)","example":"GB"}}},"PartnerCardTransactionPos":{"type":"object","properties":{"panEntryMode":{"type":"string","description":"Primary Account Number entry mode","example":"CHIP"},"pinEntryMode":{"type":"string","description":"PIN entry mode","example":"ENTERED"},"cardPresent":{"type":"boolean","description":"Indicates if the card was physically present","example":true},"pinPresent":{"type":"boolean","description":"Indicates if PIN was entered","example":false},"partialApprovalCapable":{"type":"boolean","description":"Indicates if partial approval is capable","example":false},"purchaseAmountOnly":{"type":"boolean","description":"Indicates if this is purchase amount only","example":true},"isRecurring":{"type":"boolean","description":"Indicates if this is a recurring transaction","example":false},"isInstallment":{"type":"boolean","description":"Indicates if this is an installment transaction","example":false},"cardHolderPresent":{"type":"boolean","description":"Indicates if cardholder was present","example":true},"countryCode":{"type":"string","description":"Country code (ISO 3166-1 alpha-2)","example":"GB"},"postCode":{"type":"string","description":"Postal code","example":"SW1A 1AA"},"terminalAttendence":{"type":"string","description":"Terminal attendance indicator","example":"ATTENDED"},"terminalId":{"type":"string","description":"Terminal identifier","example":"TERM001"},"terminalLocation":{"type":"string","description":"Terminal location","example":"IN_STORE"}}},"PartnerTransactionMerchantAddressPayload":{"type":"object","properties":{"flatNumber":{"type":"string","description":"Flat Number","example":"","nullable":true},"buildingNumber":{"type":"string","description":"Building Number","example":"","nullable":true},"buildingName":{"type":"string","description":"Building Name","example":"","nullable":true},"street":{"type":"string","description":"Street","example":"","nullable":true},"subStreet":{"type":"string","description":"Sub Street","example":"","nullable":true},"town":{"type":"string","description":"Town","example":"","nullable":true},"state":{"type":"string","description":"State","example":"","nullable":true},"line1":{"type":"string","description":"Address Line 1","example":"","nullable":true},"line2":{"type":"string","description":"Address Line 2","example":"","nullable":true},"line3":{"type":"string","description":"Address Line 3","example":"","nullable":true},"postcode":{"type":"string","description":"Postcode","example":"SW11 3GJ"},"country":{"type":"string","description":"Country","example":"GBR"}},"required":["postcode","country"]},"PartnerTransactionMerchantLocationPayload":{"type":"object","properties":{"latitude":{"type":"string","description":"Latitude","example":"51.46358"},"longitude":{"type":"string","description":"Longitude","example":"-0.1861"}},"required":["latitude","longitude"]},"PartnerTransactionMerchantPayload":{"type":"object","properties":{"id":{"type":"string","description":"Merchant id","example":""},"name":{"type":"string","description":"Merchant name","example":"Tesco"},"summary":{"type":"string","description":"Merchant summary","example":"Hyper-Supermarket","nullable":true},"imageUrl":{"type":"string","description":"Merchant image url","example":"https://s3.eu-central-1.amazonaws.com/files.node-prod.dateio.cz/m/538VqZ4gn33tVJJWEYa8d3/l","nullable":true},"webAddressUrl":{"type":"string","description":"Merchant web address url","example":"","nullable":true},"address":{"description":"Merchant address","nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerTransactionMerchantAddressPayload"}]},"location":{"description":"Merchant location","nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerTransactionMerchantLocationPayload"}]}},"required":["id","name"]},"PartnerTransactionCardMetadataPayload":{"type":"object","properties":{"phase":{"type":"string","description":"Phase of the card transaction.","example":"AUTHORIZATION","enum":["AUTHORIZATION","INCREMENTAL","ADVICE","REVERSAL","EXPIRATION_REVERSAL","CLEARING","FORCE_CLEARING"]},"type":{"type":"string","description":"Type of the card transaction. Optional but recommended for accurate reference generation.","example":"CARD_PAYMENT","enum":["ACTIVE_CARD_CHECK","CARD_PAYMENT","REFUND","ATM_WITHDRAWAL","ORIGINAL_CREDIT","CASHBACK","QUASI_CASH"]},"cardToken":{"type":"string","description":"Unique reference for the card.","example":"1483d25d-3f00-4d39-90ce-2379a130becd","format":"uuid"},"transactionToken":{"type":"string","description":"Unique reference for the card transaction, to logically group multiple events.","example":"1483d25d-3f00-4d39-90ce-2379a130becd","format":"uuid"},"eventToken":{"type":"string","description":"Unique reference for the card event.","example":"1483d25d-3f00-4d39-90ce-2379a130becd","format":"uuid"},"lastDigits":{"type":"string","description":"Last 4 digits of the card.","example":"1234","pattern":"^[0-9]{4}$"},"scheme":{"description":"Card transaction scheme information (network, bin prefix, etc.).","example":{"network":"MasterCard","binPrefix":"5432","referenceId":"ref123"},"allOf":[{"$ref":"#/components/schemas/PartnerCardTransactionScheme"}]},"cardAcceptor":{"description":"Card acceptor information (merchant details).","example":{"mcc":"5411","name":"Supermarket","city":"London","country":"GB"},"allOf":[{"$ref":"#/components/schemas/PartnerCardTransactionAcceptor"}]},"pos":{"description":"Point of sale information.","example":{"cardPresent":true,"pinPresent":false,"terminalId":"TERM001"},"allOf":[{"$ref":"#/components/schemas/PartnerCardTransactionPos"}]},"merchant":{"description":"Merchant information.","example":{"name":"Tesco","summary":"Hyper-Supermarket","imageUrl":"https://s3.eu-central-1.amazonaws.com/files.node-prod.dateio.cz/m/538VqZ4gn33tVJJWEYa8d3/l","location":{"latitude":51.46358,"longitude":-0.1861}},"allOf":[{"$ref":"#/components/schemas/PartnerTransactionMerchantPayload"}]}},"required":["phase","transactionToken","eventToken","lastDigits"]},"PartnerTransactionProgressPayload":{"type":"object","properties":{"event":{"type":"string","description":"Progress event type for the transaction","enum":["EXPECTED_INBOUND","EXPECTED_OUTBOUND","PLATFORM_VERIFIED","PAYMENT_VERIFIED","COMPLETED","CANCELLED"],"example":"COMPLETED"},"date":{"format":"date-time","type":"string","description":"Timestamp of when the event occurred","example":"2025-01-01T10:16:49.621Z"}},"required":["event","date"]},"PartnerPaymentFundingSourceResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the funding source","example":"f49281c0-0840-55bd-95b3-3b46d1d0e9f1","format":"uuid"},"name":{"type":"string","description":"Display name of the funding source","example":"John Doe"},"type":{"type":"string","enum":["PISP"],"description":"Type of funding source","example":"PISP"},"logo":{"type":"string","description":"Logo URL representing the funding source","example":"https://app-static.algbra.com/banklogo/mock-payments-gb-redirect.png","nullable":true}},"required":["id","name","type"]},"PartnerTransactionTransferMetadataPayload":{"type":"object","properties":{"rails":{"type":"string","description":"Outbound rails used for the transfer, if applicable","enum":["FASTER_PAYMENTS","CHAPS","BACS","INTERNAL","INTERNATIONAL"],"example":"FASTER_PAYMENTS","nullable":true},"transactionProgress":{"nullable":true,"description":"Timeline of progress events for this transfer","type":"array","items":{"$ref":"#/components/schemas/PartnerTransactionProgressPayload"}},"fundingSourceProvider":{"nullable":true,"description":"Funding source provider","allOf":[{"$ref":"#/components/schemas/PartnerPaymentFundingSourceResponse"}]},"transferType":{"type":"string","enum":["OUTBOUND_CONTACT","INBOUND_PISP","INBOUND_LINK","INBOUND_RAILS","OUTBOUND_LINK","SPLIT_REQUEST","CUBE_TRANSFER","OUTBOUND_NOMINATED","RETURN"]},"returnReason":{"type":"string","enum":["ACCOUNT_SUSPENDED","INBOUND_PAYMENTS_RESTRICTED","PROVIDER_INITIATED","REFUND","CUBE_LOCKED_INBOUND_DISALLOWED"]},"returnExplanation":{"type":"string"},"automatedPaymentId":{"type":"string","format":"uuid"},"automatedPaymentType":{"type":"string","enum":["DIRECT_DEBIT"]}}},"PartnerTransactionInvestmentMetadataPayload":{"type":"object","properties":{"collectionDate":{"format":"date-time","type":"string","description":"Collection date","example":"2026-03-31T16:09:33.671Z"},"placementDate":{"format":"date-time","type":"string","description":"Placement date","example":"2026-04-02T00:00:00.000Z"},"maturityDate":{"format":"date-time","type":"string","description":"Maturity date","example":"2026-10-02T12:00:00.000Z"},"settlementDate":{"format":"date-time","type":"string","description":"Settlement date","example":"2026-10-02T18:00:00.000Z"},"subscriptionId":{"type":"string","description":"Subscription id","example":"add57586-1ed7-4374-9e56-c62f17fe2426","format":"uuid"},"productVariantId":{"type":"string","description":"Product variant id","example":"6929c0f8a3fc67ff7fa8ecd1"},"reason":{"type":"string","description":"Reason","enum":["COLLECTION","PLACEMENT","SETTLEMENT","EXPECTED_RETURN","CANCEL_EXPECTED_RETURN","ACTUAL_RETURN"],"example":"COLLECTION"},"returns":{"type":"number","description":"Expected return amount in minor units (e.g. 129 for £1.29)","example":129}},"required":["collectionDate","placementDate","maturityDate","settlementDate","subscriptionId","productVariantId","reason","returns"]},"PartnerTransactionResponse":{"type":"object","properties":{"transactionId":{"type":"string","description":"Unique identifier of the transaction","example":"68c2a19131a3b726fe47fdda"},"uniqueToken":{"type":"string","format":"uuid","description":"Unique token of the transaction","example":"1489dd60-aa06-48a6-a267-e7d4a9a84200"},"origin":{"type":"string","description":"Origin of the transaction","enum":["TRANSFER","CARD","AUTOMATED_PAYMENT","INVESTMENTS"],"example":"TRANSFER"},"state":{"type":"string","description":"Current state of the transaction","enum":["EXPECTED","PENDING","COMPLETED","CANCELLED","FAILED"],"example":"COMPLETED"},"category":{"type":"string","description":"Category of the transaction","enum":["GENERAL","SHOPPING","TRANSFERS","EATING_OUT","DONATIONS","FAMILY","CASH","ENTERTAINMENT","EXPENSES","GIFTS","GROCERIES","HOLIDAYS","INVESTMENTS","PERSONAL_CARE","SALARY","SAVINGS","SERVICES","TRANSPORT","UTILITIES","CASHBACK_REWARDS","REFERRAL_REWARDS"],"example":["TRANSFERS"]},"impactType":{"type":"string","description":"Indicates if the transaction is a debit or credit","enum":["NEUTRAL","DEBIT","CREDIT"],"example":"CREDIT"},"customerId":{"type":"string","description":"Customer identifier associated with this transaction","example":"a2b9649e-df7f-4349-adff-1c57283fef10","format":"uuid","nullable":true},"programId":{"type":"string","description":"Program account identifier associated with this transaction","example":"a2b9649e-df7f-4349-adff-1c57283fef10","format":"uuid","nullable":true},"accountId":{"type":"string","description":"Account identifier associated with this transaction","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid","nullable":true},"sourceAccountId":{"type":"string","description":"Account identifier for source","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid","nullable":true},"destinationAccountId":{"type":"string","description":"Account identifier for destination","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid","nullable":true},"amount":{"type":"number","description":"Transaction amount in minor units (e.g. 129 for £1.29)","example":129},"currencyCode":{"type":"string","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP","description":"Currency of the transaction amount"},"description":{"type":"string","description":"Description of the transaction","example":"Sent from Algbra"},"exchangeRate":{"type":"string","description":"Exchange rate applied to this transaction","example":"1.0"},"exchangeCurrencyCode":{"type":"string","description":"Currency used for exchange in this transaction","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP"},"sourceCounterparty":{"oneOf":[{"$ref":"#/components/schemas/PartnerPaymentReferenceCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentAccountIdCounterpartyPayload"}],"description":"Details of the counterparty sending the payment, if applicable"},"destinationCounterparty":{"oneOf":[{"$ref":"#/components/schemas/PartnerPaymentReferenceCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentAccountIdCounterpartyPayload"}],"description":"Details of the counterparty receiving the payment, if applicable"},"transactionDate":{"format":"date-time","type":"string","description":"Timestamp when the transaction took place","example":"2025-01-01T10:32:01.162Z"},"cardMetadata":{"nullable":true,"description":"Additional metadata about the card process","allOf":[{"$ref":"#/components/schemas/PartnerTransactionCardMetadataPayload"}]},"transferMetadata":{"nullable":true,"description":"Additional metadata about the transfer process","allOf":[{"$ref":"#/components/schemas/PartnerTransactionTransferMetadataPayload"}]},"investmentMetadata":{"nullable":true,"description":"Additional metadata about the investment process","allOf":[{"$ref":"#/components/schemas/PartnerTransactionInvestmentMetadataPayload"}]}},"required":["transactionId","uniqueToken","origin","state","category","impactType","customerId","programId","accountId","sourceAccountId","destinationAccountId","amount","currencyCode","description","exchangeRate","exchangeCurrencyCode","sourceCounterparty","destinationCounterparty","transactionDate"]},"PartnerBusinessScheduleWorkingDaysOfWeekResponse":{"type":"object","properties":{"monday":{"type":"boolean","example":true,"description":"Monday of week"},"tuesday":{"type":"boolean","example":true,"description":"Tuesday of week"},"wednesday":{"type":"boolean","example":true,"description":"Wednesday of week"},"thursday":{"type":"boolean","example":true,"description":"Thursday of week"},"friday":{"type":"boolean","example":true,"description":"Friday of week"},"saturday":{"type":"boolean","example":false,"description":"Saturday of week"},"sunday":{"type":"boolean","example":false,"description":"Sunday of week"}},"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"PartnerBusinessScheduleResponse":{"type":"object","properties":{"id":{"type":"string","example":"6929a84aa3fc67ff7fa8ec46","description":"Unique identifier of the business schedule"},"region":{"type":"string","example":"UK_ENGLAND","description":"Region"},"workingDaysOfWeek":{"description":"Week day model to specify working days","allOf":[{"$ref":"#/components/schemas/PartnerBusinessScheduleWorkingDaysOfWeekResponse"}]},"nonWorkingDaysOfYear":{"description":"Non working days of the year","example":["2026-01-01","2026-12-28"],"type":"array","items":{"type":"array"}}},"required":["id","region","workingDaysOfWeek","nonWorkingDaysOfYear"]},"PartnerProductProviderResponse":{"type":"object","properties":{"id":{"type":"string","example":"6929ae49a3fc67ff7fa8ec68","description":"Unique identifier of the product provider"},"name":{"type":"string","example":"BANK_OF_ENGLAND","description":"Name of the product provider"},"region":{"type":"string","example":"UK_ENGLAND","description":"Region of the product provider"},"businessSchedule":{"description":"Specifies working days of week and non-working days","allOf":[{"$ref":"#/components/schemas/PartnerBusinessScheduleResponse"}]},"imageUrl":{"type":"string","description":"Image url of the product provider"}},"required":["id","name","region","businessSchedule"]},"PartnerProductPlanetImpactResponse":{"type":"object","properties":{"co2AvoidanceRatio":{"type":"number","example":0.25,"description":"Carbon avoidance ratio"},"cleanWaterImpactRatio":{"type":"number","example":0.4,"description":"Clean water generation ratio"}},"required":["co2AvoidanceRatio","cleanWaterImpactRatio"]},"PartnerProductResponse":{"type":"object","properties":{"id":{"type":"string","example":"69cd09c496504d5f5905ec98","description":"Unique identifier of the product"},"name":{"type":"string","example":"EPR Product","description":"Name of the product"},"calculationMethod":{"type":"string","description":"Calculation method of the rate","enum":["AER","EPR"],"example":"EPR"},"currencyCode":{"type":"string","description":"Currency of the product","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP"},"type":{"type":"string","description":"Type of investment the product","enum":["FIXED_TERM_DEPOSIT"],"example":"FIXED_TERM_DEPOSIT"},"settlementType":{"type":"string","description":"Settlement type of the product","enum":["SETTLE_TO_PRIMARY_ACCOUNT","SETTLE_TO_VIRTUAL_ACCOUNT"],"example":"SETTLE_TO_VIRTUAL_ACCOUNT"},"provider":{"description":"Provider of the product","allOf":[{"$ref":"#/components/schemas/PartnerProductProviderResponse"}]},"planetImpact":{"description":"Planet impact of the product","allOf":[{"$ref":"#/components/schemas/PartnerProductPlanetImpactResponse"}]},"createdOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product","example":"2025-01-01T10:32:01.162Z"},"updatedOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product","example":"2025-01-01T10:32:01.162Z"}},"required":["id","name","calculationMethod","currencyCode","type","settlementType","provider","planetImpact","createdOn"]},"PartnerProductVariantResponse":{"type":"object","properties":{"id":{"type":"string","example":"6929c0f8a3fc67ff7fa8ecd1","description":"Unique identifier of the product variant"},"name":{"type":"string","example":"EPR Product - 3 Months","description":"Name of the financial product variant"},"duration":{"type":"number","example":3,"description":"Duration value of the product variant (e.g. 3)"},"durationType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"example":"MONTH","description":"Unit of duration (e.g. DAY, MONTH, YEAR)"},"rate":{"type":"number","example":4.62,"description":"Calculated rate of the product variant based on calculationMethod"},"rateUnit":{"type":"string","description":"Unit of the rate","enum":["BPS","PERCENTAGE","DECIMAL"],"example":"PERCENTAGE"},"grossRate":{"type":"number","example":4.5,"description":"Gross rate of the product variant"},"grossRateUnit":{"type":"string","description":"Unit of the gross rate","enum":["BPS","PERCENTAGE","DECIMAL"],"example":"PERCENTAGE"},"validFrom":{"format":"date-time","type":"string","example":"2026-01-01T00:00:00.000Z","description":"Start date when the product variant is valid"},"validUntil":{"format":"date-time","type":"string","example":"2026-12-31T23:59:59.000Z","description":"End date when the product variant is no longer valid"},"maxCapacity":{"type":"number","example":1000000,"description":"Maximum total capacity for this product variant"},"minDeposit":{"type":"number","example":1000,"description":"Minimum deposit amount allowed"},"maxDeposit":{"type":"number","example":50000,"description":"Maximum deposit amount allowed per transaction"},"minReturn":{"type":"number","example":50,"description":"Minimum guaranteed return amount"},"maxDepositPerCustomer":{"type":"number","example":200000,"description":"Maximum deposit allowed per customer"},"placementCutOffTimeDaysOfWeek":{"example":[],"description":"Allowed days of the week for placement cutoff","type":"array","items":{"type":"string"}},"placementCutOffTimeLength":{"type":"number","example":2,"description":"Length value for placement cutoff time (e.g. 2 hours/days depending on type)"},"placementCutOffTimeReferenceDate":{"format":"date-time","type":"string","description":"Reference point used for placement cutoff calculation","example":"2026-04-13T00:00:00.000Z"},"placementCutOffTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"example":"DAY","description":"Type of placement cutoff time"},"placementCutOffTimeWeekInterval":{"type":"number","example":1,"description":"Week interval for placement cutoff scheduling"},"placementLeadTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"example":"DAY","description":"Type of placement lead time"},"placementLeadTimeLength":{"type":"number","example":1,"description":"Number of units for placement lead time"},"settlementLeadTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"example":"DAY","description":"Type of settlement lead time"},"settlementLeadTimeLength":{"type":"number","example":2,"description":"Number of units for settlement lead time"},"accrualStartOffsetLength":{"type":"number","example":0,"description":"Offset before accrual starts"},"accrualStartOffsetType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"example":"DAY","description":"Unit type for accrual start offset"},"maturityTimeLength":{"type":"number","example":1,"description":"Maturity time length after duration ends"},"maturityTimeType":{"type":"string","enum":["MINUTE","HOUR","DAY","MONTH","YEAR"],"example":"DAY","description":"Unit of maturity time"},"eligibleCountries":{"type":"array","example":["GBR"],"description":"List of eligible country codes.","items":{"type":"string","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"]}},"eligibleCustomerTypes":{"type":"array","example":["PERSONAL"],"description":"Eligible customer types for this product variant","items":{"type":"string","enum":["PERSONAL","BUSINESS"]}},"isPopular":{"type":"boolean","example":true,"description":"Indicates whether the product variant is marked as popular"},"sdgContributions":{"type":"array","example":["SDG_1","SDG_2"],"description":"Sustainable Development Goals (SDG) contributions associated with this product variant","items":{"type":"string","enum":["SDG_1","SDG_2","SDG_3","SDG_4","SDG_5","SDG_6","SDG_7","SDG_8","SDG_9","SDG_10","SDG_11","SDG_12","SDG_13","SDG_14","SDG_15","SDG_16","SDG_17"]}},"product":{"description":"Product of this product variant","allOf":[{"$ref":"#/components/schemas/PartnerProductResponse"}]},"createdOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product variant","example":"2025-01-01T10:32:01.162Z"},"updatedOn":{"format":"date-time","type":"string","description":"Creation timestamp of the product variant","example":"2025-01-01T10:32:01.162Z"},"deleted":{"type":"boolean","example":false,"description":"Indicates whether the product variant is deleted"}},"required":["id","name","duration","durationType","rate","rateUnit","grossRate","grossRateUnit","validFrom","minDeposit","product","createdOn"]},"PartnerProductActivityProvisionRequest":{"type":"object","properties":{"expectedReturnsPaymentId":{"type":"string","example":"1489dd60-aa06-48a6-a267-e7d4a9a84200","format":"uuid"},"reason":{"type":"string","enum":["COLLECTION","PLACEMENT","SETTLEMENT","EXPECTED_RETURN","CANCEL_EXPECTED_RETURN","ACTUAL_RETURN"],"example":"COLLECTION"}},"required":["reason"]},"Error":{"type":"object","properties":{}},"PartnerProductActivityProvisionResult":{"type":"object","properties":{"success":{"type":"boolean","example":true},"reason":{"$ref":"#/components/schemas/Error"},"paymentId":{"type":"string","example":"1489dd60-aa06-48a6-a267-e7d4a9a84200","format":"uuid"}},"required":["success"]},"PartnerProductActivityResponse":{"type":"object","properties":{"id":{"type":"string","example":"4fc0b733-9bc0-48dc-9fcd-e28ed85a6dd7","description":"Unique identifier of the activity","format":"uuid"},"phase":{"type":"string","description":"Phase","enum":["FUNDS_COLLECTION","FUNDS_PLACEMENT","FUNDS_SETTLEMENT","EARLY_WITHDRAWAL"],"example":"FUNDS_COLLECTION"},"processingStatus":{"type":"string","description":"Processing status","enum":["INITIALIZED","ACCEPTED","FAILED","REINITIALIZED"],"example":"INITIALIZED"},"provisionRequest":{"description":"Provision request","type":"array","items":{"$ref":"#/components/schemas/PartnerProductActivityProvisionRequest"}},"provisionResult":{"description":"Provision result","type":"array","items":{"$ref":"#/components/schemas/PartnerProductActivityProvisionResult"}},"createDate":{"format":"date-time","type":"string","description":"Create date","example":"2026-04-13T14:39:42.464Z"}},"required":["id","phase","processingStatus","createDate"]},"PartnerSubscriptionResponse":{"type":"object","properties":{"id":{"type":"string","example":"add57586-1ed7-4374-9e56-c62f17fe2426","description":"Unique identifier of the subscription","format":"uuid"},"amount":{"type":"number","description":"Subscription amount in minor units (e.g. 129 for £1.29)","example":129},"currencyCode":{"type":"string","description":"Currency code","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP"},"primaryAccountId":{"type":"string","description":"Parent account id","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid"},"virtualAccountId":{"type":"string","description":"Virtual account id","example":"ae66fcb2-2852-4568-990d-accc78572e4d","format":"uuid"},"customerId":{"type":"string","description":"Customer id","example":"a2b9649e-df7f-4349-adff-1c57283fef10","format":"uuid"},"productVariantId":{"type":"string","description":"Product variant id","example":"6929c0f8a3fc67ff7fa8ecd1"},"productVariant":{"description":"Product variant","allOf":[{"$ref":"#/components/schemas/PartnerProductVariantResponse"}]},"collectionDate":{"format":"date-time","type":"string","example":"2026-12-26T14:00:00.000Z","description":"Settlement date"},"placementDate":{"format":"date-time","type":"string","example":"2026-12-27T00:00:00.000Z","description":"Settlement date"},"maturityDate":{"format":"date-time","type":"string","example":"2026-12-28T00:00:00.000Z","description":"Settlement date"},"settlementDate":{"format":"date-time","type":"string","example":"2026-12-29T00:00:00.000Z","description":"Settlement date"},"returns":{"type":"number","description":"Expected return amount in minor units (e.g. 129 for £1.29)","example":129},"co2Avoided":{"type":"number","description":"Describes how much co2 avoided"},"cleanWaterImpacted":{"type":"number","description":"Describes how much clean water generated"},"state":{"type":"string","description":"Investment state","enum":["UNKNOWN","PENDING","CREATED","EARLY_WITHDRAWAL","COMPLETED","FAILED"],"example":"CREATED"},"progress":{"type":"number","description":"Progressed percentage of the investment period lifecycle for this subscription","example":100},"activities":{"description":"Activities related with subscription","type":"array","items":{"$ref":"#/components/schemas/PartnerProductActivityResponse"}},"createDate":{"format":"date-time","type":"string","description":"Create date","example":"2026-04-13T14:39:42.464Z"},"updateDate":{"format":"date-time","type":"string","description":"Update date","example":"2026-04-13T14:39:45.464Z"}},"required":["id","amount","currencyCode","primaryAccountId","virtualAccountId","customerId","productVariantId","collectionDate","placementDate","maturityDate","settlementDate","returns","createDate"]},"PartnerCreateSubscriptionRequest":{"type":"object","properties":{"customerId":{"type":"string","description":"Customer ID that will be the account owner.","example":"a2b9649e-df7f-4349-adff-1c57283fef10","format":"uuid"},"idempotencyKey":{"type":"string","description":"A unique idempotency key to prevent duplicate subscription.","example":"1483d25d-3f00-4d39-90ce-2379a130becd","format":"uuid"},"externalReference":{"type":"string","description":"Reference identifier provided by partner.","example":"ae588135-0391-42a8-a4e4-e8e7645fa707","format":"uuid","nullable":true},"primaryAccountId":{"type":"string","description":"The primary account id under which the virtual account will be created.","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid"},"productVariantId":{"type":"string","description":"The product variant id which will be subscribed.","example":"6929c0f8a3fc67ff7fa8ecd1"},"amount":{"type":"number","description":"Amount in minor units (e.g. 129 for £1.29)","example":129}},"required":["customerId","idempotencyKey","primaryAccountId","productVariantId","amount"]},"PartnerProductVariantReturnsResponse":{"type":"object","properties":{"principal":{"type":"number","description":"Principal amount used for return calculation.","example":100},"collectionDate":{"format":"date-time","type":"string","description":"Estimated collection date.","example":"2026-06-23T13:28:01.581Z"},"placementDate":{"format":"date-time","type":"string","description":"Estimated placement date.","example":"2026-06-23T13:30:01.581Z"},"maturityDate":{"format":"date-time","type":"string","description":"Estimated maturity date.","example":"2026-06-23T13:32:01.581Z"},"settlementDate":{"format":"date-time","type":"string","description":"Estimated settlement date.","example":"2026-06-23T13:32:01.581Z"},"returns":{"type":"number","description":"Calculated return amount.","example":250},"co2Avoided":{"type":"number","description":"Estimated CO2 avoided.","example":0,"nullable":true},"cleanWaterImpacted":{"type":"number","description":"Estimated clean water impacted.","example":0,"nullable":true}},"required":["principal","collectionDate","placementDate","maturityDate","settlementDate","returns"]},"PartnerPaymentVerificationMetadata":{"type":"object","properties":{"verificationType":{"type":"string","description":"Type of verification applied.","enum":["BIOMETRIC_VERIFIED","DEVICE_VERIFIED","SMS_OTP_VERIFIED","VOICE_OTP_VERIFIED","WHATSAPP_OTP_VERIFIED","EMAIL_OTP_VERIFIED","AGENT_VERIFIED"],"example":"SMS_OTP_VERIFIED","nullable":true},"verificationReference":{"type":"string","description":"Reference identifier for the verification.","nullable":true},"exemptionType":{"type":"string","description":"Exemption type applied to the payment verification.","enum":["LOW_VALUE","NOMINATED_COUNTERPARTY","RECURRING_PAYMENT","INTERNAL_COUNTERPARTY","OTHER"],"example":"INTERNAL_COUNTERPARTY","nullable":true},"exemptionReason":{"type":"string","description":"Reason for the applied exemption.","nullable":true}}},"PartnerPaymentInternalPayload":{"type":"object","properties":{"sourceAccountId":{"type":"string","description":"Account id of the source account from which payment is sent","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid"},"destinationAccountId":{"type":"string","description":"Account id of the destination account which receiving the payment","example":"ae66fcb2-2852-4568-990d-accc78572e4d","format":"uuid"},"idempotencyKey":{"type":"string","description":"Unique key to ensure idempotency of payment requests","example":"1483d25d-3f00-4d39-90ce-2379a130becd","format":"uuid"},"amount":{"type":"number","description":"Amount in minor units (e.g. for £1.29 enter 129)","example":129},"externalReference":{"type":"string","description":"Reference identifier provided by partner.","example":"ae588135-0391-42a8-a4e4-e8e7645fa707","format":"uuid","nullable":true},"description":{"type":"string","description":"Description of the payment","example":"Sent from Algbra","maxLength":140,"nullable":true},"verificationMetadata":{"description":"Metadata required to verify the payment request","allOf":[{"$ref":"#/components/schemas/PartnerPaymentVerificationMetadata"}]},"purpose":{"type":"string","description":"Purpose of the payment","example":"PAY_INVOICE","enum":["UNKNOWN","PAYING_FAMILY_OR_FRIEND","TRANSFER_OWN_OTHER_BANK_ACCOUNT","BUY_SOMETHING","PAY_INVOICE","SALARY_OR_WAGES","GOVERNMENT_PAYMENT","TAX_PAYMENT","LOAN_REPAYMENT","BUYING_HOME_OR_PAYING_SOLICITOR","PAYING_BUILDER_OR_TRADESPERSON","INVESTMENTS","PAYING_RENT","CHARITABLE_DONATION","OTHER","REFUND","TREASURY_PAYMENT","TREASURY_NETTING","CARD_SCHEME_SETTLEMENT","GENERIC_FEES","SAVINGS_PAYMENT","GIFT_PAYMENT"],"nullable":true}},"required":["sourceAccountId","destinationAccountId","idempotencyKey","amount","verificationMetadata"]},"PartnerPaymentExternalPayload":{"type":"object","properties":{"sourceAccountId":{"type":"string","description":"Source account id from which payment is sent","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid"},"destinationCounterparty":{"description":"Counterparty details of the payment destination","allOf":[{"$ref":"#/components/schemas/PartnerPaymentReferenceCounterpartyPayload"}]},"idempotencyKey":{"type":"string","description":"Unique key to ensure idempotency of payment requests","example":"1483d25d-3f00-4d39-90ce-2379a130becd","format":"uuid"},"amount":{"type":"number","description":"Amount in minor units (e.g. for £1.29 enter 129)","example":129},"externalReference":{"type":"string","description":"Reference identifier provided by partner.","example":"ae588135-0391-42a8-a4e4-e8e7645fa707","format":"uuid","nullable":true},"description":{"type":"string","description":"Description of the payment","example":"Sent from Algbra","maxLength":140,"nullable":true},"rails":{"type":"string","default":"FASTER_PAYMENTS","description":"The payment rail to use (e.g. Faster Payments)","enum":["FASTER_PAYMENTS","CHAPS","BACS","INTERNAL","INTERNATIONAL"],"example":"FASTER_PAYMENTS","nullable":true},"railsPolicy":{"type":"string","default":"DETECT","description":"Policy for determining which rail to use","enum":["FIXED","DETECT"],"nullable":true},"verificationMetadata":{"description":"Metadata required to verify the payment request","allOf":[{"$ref":"#/components/schemas/PartnerPaymentVerificationMetadata"}]},"purpose":{"type":"string","description":"Purpose of the payment","example":"PAY_INVOICE","enum":["UNKNOWN","PAYING_FAMILY_OR_FRIEND","TRANSFER_OWN_OTHER_BANK_ACCOUNT","BUY_SOMETHING","PAY_INVOICE","SALARY_OR_WAGES","GOVERNMENT_PAYMENT","TAX_PAYMENT","LOAN_REPAYMENT","BUYING_HOME_OR_PAYING_SOLICITOR","PAYING_BUILDER_OR_TRADESPERSON","INVESTMENTS","PAYING_RENT","CHARITABLE_DONATION","OTHER","REFUND","TREASURY_PAYMENT","TREASURY_NETTING","CARD_SCHEME_SETTLEMENT","GENERIC_FEES","SAVINGS_PAYMENT","GIFT_PAYMENT"],"nullable":true},"ultimateSourceCounterparty":{"description":"Ultimate source counterparty details of the payment","nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerPaymentReferenceCounterpartyPayload"}]},"ultimateDestinationCounterparty":{"description":"Ultimate destination counterparty details of the payment","nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerPaymentReferenceCounterpartyPayload"}]}},"required":["sourceAccountId","destinationCounterparty","idempotencyKey","amount","verificationMetadata"]},"PartnerPaymentFundingInitiatePayload":{"type":"object","properties":{"fundingSourceType":{"type":"string","description":"Type of funding source.","example":"PISP","enum":["PISP"]},"fundingSourceProviderId":{"type":"string","description":"ID of the funding source provider.","example":"f49281c0-0840-55bd-95b3-3b46d1d0e9f1","format":"uuid"},"destinationAccountId":{"type":"string","description":"ID of the destination account to fund.","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid"},"externalReference":{"type":"string","description":"Reference identifier provided by partner.","example":"ae588135-0391-42a8-a4e4-e8e7645fa707","format":"uuid","nullable":true},"amount":{"type":"number","description":"Amount of the funding in minor units (e.g., for £1.29 enter 129).","example":129},"idempotencyKey":{"type":"string","description":"Idempotency key to prevent duplicate funding operations.","example":"1483d25d-3f00-4d39-90ce-2379a130becd","format":"uuid"}},"required":["fundingSourceType","fundingSourceProviderId","destinationAccountId","amount","idempotencyKey"]},"PartnerCardFundingInitiatePayload":{"type":"object","properties":{"amount":{"type":"number","description":"Amount of the funding in minor units (e.g., for £1.29 enter 129).","example":129},"idempotencyKey":{"type":"string","description":"Idempotency key to prevent duplicate funding operations.","example":"1483d25d-3f00-4d39-90ce-2379a130becd","format":"uuid"},"externalReference":{"type":"string","description":"External reference identifier provided by partner.","example":"550e8400-e29b-41d4-a716-446655440000","format":"uuid","nullable":true},"phase":{"type":"string","description":"Phase of the card transaction.","example":"AUTHORIZATION","enum":["AUTHORIZATION","INCREMENTAL","ADVICE","REVERSAL","EXPIRATION_REVERSAL","CLEARING","FORCE_CLEARING"]},"type":{"type":"string","description":"Type of the card transaction. Optional but recommended for accurate reference generation.","example":"CARD_PAYMENT","enum":["ACTIVE_CARD_CHECK","CARD_PAYMENT","REFUND","ATM_WITHDRAWAL","ORIGINAL_CREDIT","CASHBACK","QUASI_CASH"]},"transactionToken":{"type":"string","description":"Unique reference for the card transaction, to logically group multiple events.","example":"1483d25d-3f00-4d39-90ce-2379a130becd","format":"uuid"},"eventToken":{"type":"string","description":"Unique reference for the card event.","example":"1483d25d-3f00-4d39-90ce-2379a130becd","format":"uuid"},"precedingToken":{"type":"string","description":"Preceding token for the card event.","example":"1483d25d-3f00-4d39-90ce-2379a130becd","format":"uuid","nullable":true},"sourceAccountId":{"type":"string","description":"ID of the source account.","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid"},"destinationAccountId":{"type":"string","description":"ID of the destination account.","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid"},"cardToken":{"type":"string","description":"Unique reference for the card.","example":"1483d25d-3f00-4d39-90ce-2379a130becd","format":"uuid"},"customerId":{"type":"string","description":"ID of the customer.","example":"1483d25d-3f00-4d39-90ce-2379a130becd","format":"uuid"},"lastDigits":{"type":"string","description":"Last 4 digits of the card.","example":"1234","pattern":"^[0-9]{4}$"},"scheme":{"description":"Card transaction scheme information (network, bin prefix, etc.).","example":{"network":"MasterCard","binPrefix":"5432","referenceId":"ref123"},"allOf":[{"$ref":"#/components/schemas/PartnerCardTransactionScheme"}]},"cardAcceptor":{"description":"Card acceptor information (merchant details).","example":{"mcc":"5411","name":"Supermarket","city":"London","country":"GB"},"allOf":[{"$ref":"#/components/schemas/PartnerCardTransactionAcceptor"}]},"pos":{"description":"Point of sale information.","example":{"cardPresent":true,"pinPresent":false,"terminalId":"TERM001"},"allOf":[{"$ref":"#/components/schemas/PartnerCardTransactionPos"}]},"approvalCode":{"type":"string","description":"Approval code.","example":"061103"},"purchaseDate":{"format":"date-time","type":"string","description":"Date of the card transaction.","nullable":true},"exchangeRate":{"type":"string","description":"Exchange rate applied to this transaction.","example":"1.70","nullable":true},"exchangeCurrencyCode":{"type":"string","description":"Currency used for exchange in this transaction.","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"TRY","nullable":true}},"required":["amount","idempotencyKey","phase","type","transactionToken","eventToken","sourceAccountId","destinationAccountId","customerId","lastDigits"]},"PartnerPaymentResponse":{"type":"object","properties":{"paymentId":{"type":"string","format":"uuid","description":"Unique identifier of the payment","example":"1489dd60-aa06-48a6-a267-e7d4a9a84200"},"processingState":{"type":"string","enum":["CREATED","PROCESSING","SUCCESS","FAILURE"],"description":"Processing state of the payment","example":"SUCCESS"},"failureReason":{"type":"string","enum":["ALREADY_PROCESS","AML_BLOCKED_INBOUND_TRANSFER","AML_BLOCKED_OUTBOUND_TRANSFER","EXCEEDS_LIMIT","INSUFFICIENT_BALANCE","INVALID_COUNTERPARTY","RAIL_NOT_SUPPORTED","RESTRICTED_INBOUND_TRANSFER","RESTRICTED_OUTBOUND_TRANSFER","TECHNICAL_ERROR","INSUFFICIENT_FUNDS","PAYMENT_NOT_RETURNABLE","DESTINATION_ACCOUNT_INVALID","DESTINATION_ACCOUNT_CLOSED","DESTINATION_ACCOUNT_BLOCKED","DESTINATION_NAME_MISMATCH","DESTINATION_DETAILS_INCORRECT","RETURNED_BY_DESTINATION_BANK","COMPLIANCE_REJECTED","SCHEME_ERROR","DUPLICATE_PAYMENT","CURRENCY_NOT_SUPPORTED","PURPOSE_NOT_SUPPORTED","PAYMENT_EXPIRED","SCHEME_CUT_OFF","UNDEFINED"],"description":"Details of the payment failure","example":"AML_BLOCKED_OUTBOUND_TRANSFER","nullable":true},"createdOn":{"format":"date-time","type":"string","description":"Timestamp when the payment was created"},"transaction":{"nullable":true,"description":"Transaction associated with the payment, if available","allOf":[{"$ref":"#/components/schemas/PartnerTransactionResponse"}]},"initiationRequest":{"description":"Original request payload that initiated the payment","oneOf":[{"$ref":"#/components/schemas/PartnerPaymentInternalPayload"},{"$ref":"#/components/schemas/PartnerPaymentExternalPayload"},{"$ref":"#/components/schemas/PartnerPaymentFundingInitiatePayload"},{"$ref":"#/components/schemas/PartnerCardFundingInitiatePayload"}]}},"required":["paymentId","processingState","createdOn","initiationRequest"]},"PartnerPaymentErrorResponse":{"type":"object","properties":{"errorType":{"type":"string","enum":["ALREADY_PROCESS","AML_BLOCKED_INBOUND_TRANSFER","AML_BLOCKED_OUTBOUND_TRANSFER","EXCEEDS_LIMIT","INSUFFICIENT_BALANCE","INVALID_COUNTERPARTY","RAIL_NOT_SUPPORTED","RESTRICTED_INBOUND_TRANSFER","RESTRICTED_OUTBOUND_TRANSFER","TECHNICAL_ERROR","INSUFFICIENT_FUNDS","PAYMENT_NOT_RETURNABLE","DESTINATION_ACCOUNT_INVALID","DESTINATION_ACCOUNT_CLOSED","DESTINATION_ACCOUNT_BLOCKED","DESTINATION_NAME_MISMATCH","DESTINATION_DETAILS_INCORRECT","RETURNED_BY_DESTINATION_BANK","COMPLIANCE_REJECTED","SCHEME_ERROR","DUPLICATE_PAYMENT","CURRENCY_NOT_SUPPORTED","PURPOSE_NOT_SUPPORTED","PAYMENT_EXPIRED","SCHEME_CUT_OFF","UNDEFINED"]},"reason":{"type":"string","nullable":true},"validationFailures":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/PartnerValidationFieldError"}}},"required":["errorType"]},"PartnerValidateCounterpartyPayload":{"type":"object","properties":{"identifierType":{"type":"string","description":"Type of account identifier used","enum":["UK_ACCOUNT","IBAN","CUSTODY_ID","OTHER_EXTERNAL","GENERIC_ACCOUNT"],"example":"UK_ACCOUNT"},"contactName":{"type":"string","description":"Full name of the counterparty contact person","example":"John Doe"},"sortCode":{"type":"string","description":"The sort code of the UK bank account","example":"010102","nullable":true},"accountNumber":{"type":"string","description":"The account number of the UK bank account","example":"12345678","nullable":true},"iban":{"type":"string","description":"The IBAN (International Bank Account Number) of the account","example":"GB33BUKB20201555555555","nullable":true},"bic":{"type":"string","description":"The BIC (Bank Identifier Code) of the account","example":"BUKBGB22","nullable":true},"accountType":{"type":"string","description":"Specifies the type of account","enum":["BUSINESS","PERSONAL","UNKNOWN"],"example":"PERSONAL"},"secondaryAccountId":{"type":"string","description":"Unique identifier for a secondary account","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","nullable":true}},"required":["identifierType","contactName","accountType"]},"PartnerValidateCounterpartyResponse":{"type":"object","properties":{"counterpartyBeneficiaryStatus":{"type":"string","description":"Validation status of the counterparty beneficiary","enum":["MATCH","PARTIAL_MATCH","NO_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":"PARTIAL_MATCH","nullable":true},"counterpartyValidationResult":{"type":"string","description":"Result of counterparty validation check","enum":["UK_ACCOUNT_VALID","UK_ACCOUNT_INVALID","IBAN_VALID","IBAN_INVALID","UNKNOWN"],"nullable":true},"similarName":{"type":"string","description":"Closest matching name suggested if counterparty name differs","example":"John Doe","nullable":true}}},"PartnerValidateCounterpartyPayloadV2":{"type":"object","properties":{"identifierType":{"type":"string","description":"Type of account identifier used","enum":["UK_ACCOUNT","IBAN","CUSTODY_ID","OTHER_EXTERNAL","GENERIC_ACCOUNT"],"example":"UK_ACCOUNT"},"contactName":{"type":"string","description":"Full name of the counterparty. Deprecated: use `details` instead, which avoids ambiguity when splitting the name into first and last name for the Confirmation of Payee check.","example":"John Doe","deprecated":true},"details":{"description":"Counterparty name details, shape depends on `accountType`: `firstName` and `lastName` for PERSONAL, `businessName` for BUSINESS, `name` for UNKNOWN. Required when `contactName` is not provided, and takes precedence over it when both are sent.","example":{"firstName":"John","lastName":"Doe"},"oneOf":[{"$ref":"#/components/schemas/PartnerPersonalDetailsPayload"},{"$ref":"#/components/schemas/PartnerBusinessDetailsPayload"},{"$ref":"#/components/schemas/PartnerUnknownDetailsPayload"}]},"sortCode":{"type":"string","description":"The sort code of the UK bank account","example":"010102","nullable":true},"accountNumber":{"type":"string","description":"Account number","example":"1234567890","nullable":true},"iban":{"type":"string","description":"The IBAN (International Bank Account Number) of the account","example":"GB33BUKB20201555555555","nullable":true},"bic":{"type":"string","description":"The BIC (Bank Identifier Code) of the account","example":"BUKBGB22","nullable":true},"routingType":{"type":"string","description":"Primary routing type (required when BIC is not provided)","enum":["ROUTING_CODE","GIRO_ROUTING_CODE","ACH_ROUTING_NUMBER","FAST_ROUTING_CODE","WIRE_ROUTING_NUMBER","MEPS_ROUTING_CODE","ABA_ROUTING_NUMBER","BANK_CODE","BRANCH_CODE","BSB_CODE","CLABE","CNAPS","IFSC","INSTITUTION_NO"],"example":"ABA_ROUTING_NUMBER","nullable":true},"routingNumber":{"type":"string","description":"Primary routing number (required when routingType is provided)","example":"026009593","nullable":true},"secondaryRoutingType":{"type":"string","description":"Secondary routing type","enum":["ROUTING_CODE","GIRO_ROUTING_CODE","ACH_ROUTING_NUMBER","FAST_ROUTING_CODE","WIRE_ROUTING_NUMBER","MEPS_ROUTING_CODE","ABA_ROUTING_NUMBER","BANK_CODE","BRANCH_CODE","BSB_CODE","CLABE","CNAPS","IFSC","INSTITUTION_NO"],"example":"ROUTING_CODE","nullable":true},"secondaryRoutingNumber":{"type":"string","description":"Secondary routing number (required when secondaryRoutingType is provided)","example":"GB33BUKB20201555555555","nullable":true},"country":{"type":"string","description":"Country of the counterparty account.","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"],"example":"GBR","nullable":true},"currency":{"type":"string","description":"Currency of the counterparty account.","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP","nullable":true},"accountType":{"type":"string","description":"Specifies the type of account","enum":["BUSINESS","PERSONAL","UNKNOWN"],"example":"PERSONAL"},"secondaryAccountId":{"type":"string","description":"Unique identifier for a secondary account","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","nullable":true},"address":{"description":"Required for non-UK accounts (IBAN / GENERIC)","nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerPaymentAddressPayload"}]}},"required":["identifierType","accountType"]},"PartnerValidateCounterpartyValidation":{"type":"object","properties":{"valid":{"type":"boolean","description":"Overall validation outcome","example":true},"checksPassed":{"type":"array","description":"List of validation checks that passed","example":["SORTCODE_VERIFICATION","MODULUS_CHECK","NAME_CHECK_COP"],"items":{"type":"string","enum":["SORTCODE_VERIFICATION","MODULUS_CHECK","NAME_CHECK_COP","NAME_CHECK_VOP","STRUCTURE_CHECK_IBAN","STRUCTURE_CHECK_BIC","BIC_VERIFICATION","SCHEME_VALIDATION"]}},"checksFailed":{"type":"array","description":"List of validation checks that failed","example":[],"items":{"type":"string","enum":["SORTCODE_VERIFICATION","MODULUS_CHECK","NAME_CHECK_COP","NAME_CHECK_VOP","STRUCTURE_CHECK_IBAN","STRUCTURE_CHECK_BIC","BIC_VERIFICATION","SCHEME_VALIDATION"]}},"errors":{"description":"Additional error details","example":["Invalid bank details provided with account reference."],"type":"array","items":{"type":"string"}}},"required":["valid"]},"PartnerValidateCounterpartyBankMetadata":{"type":"object","properties":{"source":{"type":"string","example":"EISCD"},"sourceId":{"type":"string","example":"04"},"bankName":{"type":"string","example":"HSBC"},"branchName":{"type":"string","example":"HSBC Branch"},"bic":{"type":"string","description":"BIC","example":"undefinedundefined"}}},"PartnerValidateCounterpartyNameCheck":{"type":"object","properties":{"assertion":{"type":"string","enum":["REQUIRED","NOT_REQUIRED","UNKNOWN"],"description":"Indicates assertion for name confirmation requirement","example":"REQUIRED"},"state":{"type":"string","enum":["MATCH","PARTIAL_MATCH","NO_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"],"description":"Name check state (when CoP/VoP is available)","example":"ACCOUNT_DOES_NOT_EXIST"},"suggestion":{"type":"string","description":"Similar name suggestion returned by CoP/VoP providers","example":"JOHN SMITH"}},"required":["assertion"]},"PartnerValidateCounterpartyResponseV2":{"type":"object","properties":{"validation":{"description":"Validation details","allOf":[{"$ref":"#/components/schemas/PartnerValidateCounterpartyValidation"}]},"bankMetadata":{"description":"Bank metadata","allOf":[{"$ref":"#/components/schemas/PartnerValidateCounterpartyBankMetadata"}]},"nameCheck":{"description":"Name check details","allOf":[{"$ref":"#/components/schemas/PartnerValidateCounterpartyNameCheck"}]}},"required":["validation"]},"PartnerSimulateFpsPayload":{"type":"object","properties":{"sourceCounterparty":{"description":"Counterparty details for the payment source","nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerPaymentReferenceCounterpartyPayload"}]},"destinationFiatAccountId":{"type":"string","description":"Account id of the destination account which receiving the payment","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid"},"amount":{"type":"number","description":"Amount in minor units (e.g. for £1.29 enter 129)","example":129},"reference":{"type":"string","description":"Description of the payment","example":"Sent from Algbra","maxLength":140,"nullable":true}},"required":["destinationFiatAccountId","amount"]},"PartnerSimulateInternationalPayload":{"type":"object","properties":{"sourceCounterparty":{"description":"Counterparty details for the payment source","nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerPaymentReferenceCounterpartyPayload"}]},"destinationFiatAccountId":{"type":"string","description":"Account id of the destination account which receiving the payment","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid"},"amount":{"type":"number","description":"Amount in minor units (e.g. for £1.29 enter 129)","example":129},"reference":{"type":"string","description":"Description of the payment","example":"Sent from Algbra","maxLength":140,"nullable":true}},"required":["destinationFiatAccountId","amount"]},"PartnerSimulateBacsPayload":{"type":"object","properties":{"type":{"type":"string","enum":["DIRECT_CREDIT","DIRECT_DEBIT"],"description":"DIRECT_CREDIT credits the account. DIRECT_DEBIT collects from it under the mandate given in automatedPaymentId.","example":"DIRECT_CREDIT"},"destinationFiatAccountId":{"type":"string","description":"Account id of the destination account which receiving the payment","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid"},"amount":{"type":"number","description":"Amount in minor units (e.g. for £1.29 enter 129)","minimum":1,"maximum":99999999999,"example":15000},"reference":{"type":"string","description":"Reference of the BACS item: uppercase letters, numbers, period, ampersand, forward slash, hyphen and space. Generated when omitted.","maxLength":18,"example":"SALARY OCT"},"sourceCounterparty":{"description":"DIRECT_CREDIT only. The originator (payer), a UK account. Defaults to a test originator the ClearBank simulator accepts.","nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerPaymentReferenceCounterpartyPayload"}]},"serviceUserNumber":{"type":"string","description":"DIRECT_CREDIT only. BACS service user number of the originator.","minLength":6,"maxLength":6,"default":"400000","example":"400000"},"automatedPaymentId":{"type":"string","description":"DIRECT_DEBIT only, and required for it. The mandate the collection is made under; its originator and service user number are used.","format":"uuid"}},"required":["type","destinationFiatAccountId","amount"]},"PartnerSimulateInboundPaymentPayload":{"type":"object","properties":{"rails":{"type":"string","default":"FASTER_PAYMENTS","description":"The payment rail to simulate (e.g. Faster Payments). BACS simulates a Direct Credit or a Direct Debit, chosen by payload.type, into a ClearBank account.","enum":["FASTER_PAYMENTS","CHAPS","BACS","INTERNAL","INTERNATIONAL"],"example":"FASTER_PAYMENTS"},"payload":{"description":"Simulation details specific to the selected payment rail","oneOf":[{"$ref":"#/components/schemas/PartnerSimulateFpsPayload"},{"$ref":"#/components/schemas/PartnerSimulateInternationalPayload"},{"$ref":"#/components/schemas/PartnerSimulateBacsPayload"}]}},"required":["rails","payload"]},"PartnerCreateReturnTransferPayload":{"type":"object","properties":{"paymentId":{"type":"string","description":"Payment id of the inbound transaction to be returned","format":"uuid"},"idempotencyKey":{"type":"string","format":"uuid"},"returnReason":{"type":"string","enum":["ACCOUNT_SUSPENDED","INBOUND_PAYMENTS_RESTRICTED","PROVIDER_INITIATED","REFUND","CUBE_LOCKED_INBOUND_DISALLOWED"],"description":"Reason for initiating the return"},"returnExplanation":{"type":"string","description":"Optional human-readable explanation for the return","maxLength":500,"nullable":true},"externalReference":{"type":"string","description":"Reference identifier provided by partner.","example":"ae588135-0391-42a8-a4e4-e8e7645fa707","format":"uuid","nullable":true}},"required":["paymentId","idempotencyKey","returnReason"]},"PartnerPaymentFundingInitiateResponse":{"type":"object","properties":{"paymentId":{"type":"string","description":"Unique identifier of the initiated payment","example":"1489dd60-aa06-48a6-a267-e7d4a9a84200","format":"uuid"},"transaction":{"nullable":true,"description":"Transaction details if available at initiation","allOf":[{"$ref":"#/components/schemas/PartnerTransactionResponse"}]},"redirectUrl":{"type":"string","description":"URL to redirect the user to complete the funding process","example":"https://openbanking.examplebank.com/login/46c7a72b-ee3f-4b57-a143-7633ab76732d#token=xyz"}},"required":["paymentId","redirectUrl"]},"PartnerCardTransactionResponse":{"type":"object","properties":{"transactionId":{"type":"string","description":"Unique identifier of the transaction","example":"68c2a19131a3b726fe47fdda"},"uniqueToken":{"type":"string","format":"uuid","description":"Unique token of the transaction","example":"1489dd60-aa06-48a6-a267-e7d4a9a84200"},"origin":{"type":"string","description":"Origin of the transaction","enum":["TRANSFER","CARD","AUTOMATED_PAYMENT","INVESTMENTS"],"example":"CARD"},"state":{"type":"string","description":"Current state of the transaction","enum":["EXPECTED","PENDING","COMPLETED","CANCELLED","FAILED"],"example":"COMPLETED"},"category":{"type":"string","description":"Category of the transaction","enum":["GENERAL","SHOPPING","TRANSFERS","EATING_OUT","DONATIONS","FAMILY","CASH","ENTERTAINMENT","EXPENSES","GIFTS","GROCERIES","HOLIDAYS","INVESTMENTS","PERSONAL_CARE","SALARY","SAVINGS","SERVICES","TRANSPORT","UTILITIES","CASHBACK_REWARDS","REFERRAL_REWARDS"],"example":["GENERAL"]},"impactType":{"type":"string","description":"Indicates if the transaction is a debit or credit","enum":["NEUTRAL","DEBIT","CREDIT"],"example":"DEBIT"},"customerId":{"type":"string","description":"Customer identifier associated with this transaction","example":"a2b9649e-df7f-4349-adff-1c57283fef10","format":"uuid","nullable":true},"programId":{"type":"string","description":"Program account identifier associated with this transaction","example":"a2b9649e-df7f-4349-adff-1c57283fef10","format":"uuid","nullable":true},"accountId":{"type":"string","description":"Account identifier associated with this transaction","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid","nullable":true},"sourceAccountId":{"type":"string","description":"Account identifier for source","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid","nullable":true},"destinationAccountId":{"type":"string","description":"Account identifier for destination","example":"e0cab2dd-739f-43de-b131-3e423e935bf1","format":"uuid","nullable":true},"amount":{"type":"number","description":"Transaction amount in minor units (e.g. 129 for £1.29)","example":129},"currencyCode":{"type":"string","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP","description":"Currency of the transaction amount"},"description":{"type":"string","description":"Description of the transaction","example":"CL4252-3423"},"exchangeRate":{"type":"string","description":"Exchange rate applied to this transaction","example":"1.0"},"exchangeCurrencyCode":{"type":"string","description":"Currency used for exchange in this transaction","enum":["AFN","EUR","ALL","DZD","USD","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","INR","BTN","BOB","BOV","BAM","BWP","NOK","BRL","BND","BGN","BIF","CVE","KHR","XAF","CAD","KYD","CLP","CLF","CNY","COP","COU","KMF","CDF","NZD","CRC","HRK","CUP","CUC","ANG","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FKP","FJD","XPF","GMD","GEL","GHS","GIP","GTQ","GBP","GNF","GYD","HTG","HNL","HKD","HUF","ISK","IDR","XDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","ZAR","LRD","LYD","CHF","MOP","MKD","MGA","MWK","MYR","MVR","MRU","MUR","XUA","MXN","MXV","MDL","MNT","MAD","MZN","MMK","NAD","NPR","NIO","NGN","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","WST","STN","SAR","RSD","SCR","SLL","SGD","XSU","SBD","SOS","SSP","LKR","SDG","SRD","SEK","CHE","CHW","SYP","TWD","TJS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","USN","UYU","UYI","UYW","UZS","VUV","VES","VND","YER","ZMW","ZWL","XBA","XBB","XBC","XBD","XTS","XXX","XAU","XPD","XPT","XAG","AFA","FIM","ADP","ESP","FRF","AOK","AOR","RUR","ATS","AYM","AZM","BYB","BYR","BEC","BEF","BEL","BAD","BRB","BRR","BGJ","CYP","CSK","ECS","ECV","GQE","EEK","XEU","GEK","DDM","DEM","GHC","GHP","GRD","GWE","ITL","IEP","LVL","ZAL","LTL","LUC","LUF","LUL","MGF","MLF","MTL","MRO","MZE","NLG","PLZ","PTE","ROK","STD","CSD","SKK","SIT","RHD","ESA","ESB","SDD","SRG","TJR","TPE","TRL","TMM","UAK","USS","VEB","VEF","YUD","ZRN","ZMK","ZWN","ZWR"],"example":"GBP"},"sourceCounterparty":{"oneOf":[{"$ref":"#/components/schemas/PartnerPaymentReferenceCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentAccountIdCounterpartyPayload"}],"description":"Details of the counterparty sending the payment, if applicable"},"destinationCounterparty":{"oneOf":[{"$ref":"#/components/schemas/PartnerPaymentReferenceCounterpartyPayload"},{"$ref":"#/components/schemas/PartnerPaymentAccountIdCounterpartyPayload"}],"description":"Details of the counterparty receiving the payment, if applicable","allOf":[{"$ref":"#/components/schemas/PartnerPaymentCustodyIdCounterpartyPayload"}]},"transactionDate":{"format":"date-time","type":"string","description":"Timestamp when the transaction took place","example":"2025-01-01T10:32:01.162Z"},"cardMetadata":{"nullable":true,"description":"Additional metadata about the card process","allOf":[{"$ref":"#/components/schemas/PartnerTransactionCardMetadataPayload"}]},"transferMetadata":{"nullable":true,"description":"Additional metadata about the transfer process","allOf":[{"$ref":"#/components/schemas/PartnerTransactionTransferMetadataPayload"}]},"investmentMetadata":{"nullable":true,"description":"Additional metadata about the investment process","allOf":[{"$ref":"#/components/schemas/PartnerTransactionInvestmentMetadataPayload"}]}},"required":["transactionId","uniqueToken","origin","state","category","impactType","customerId","programId","accountId","sourceAccountId","destinationAccountId","amount","currencyCode","description","exchangeRate","exchangeCurrencyCode","sourceCounterparty","destinationCounterparty","transactionDate"]},"PartnerCardFundingResponse":{"type":"object","properties":{"paymentId":{"type":"string","format":"uuid","description":"Unique identifier of the card funding","example":"1489dd60-aa06-48a6-a267-e7d4a9a84200"},"processingState":{"type":"string","enum":["CREATED","PROCESSING","SUCCESS","FAILURE"],"description":"Processing state of the card funding","example":"SUCCESS"},"failureReason":{"type":"string","enum":["ALREADY_PROCESS","AML_BLOCKED_INBOUND_TRANSFER","AML_BLOCKED_OUTBOUND_TRANSFER","EXCEEDS_LIMIT","INSUFFICIENT_BALANCE","INVALID_COUNTERPARTY","RAIL_NOT_SUPPORTED","RESTRICTED_INBOUND_TRANSFER","RESTRICTED_OUTBOUND_TRANSFER","TECHNICAL_ERROR","INSUFFICIENT_FUNDS","PAYMENT_NOT_RETURNABLE","DESTINATION_ACCOUNT_INVALID","DESTINATION_ACCOUNT_CLOSED","DESTINATION_ACCOUNT_BLOCKED","DESTINATION_NAME_MISMATCH","DESTINATION_DETAILS_INCORRECT","RETURNED_BY_DESTINATION_BANK","COMPLIANCE_REJECTED","SCHEME_ERROR","DUPLICATE_PAYMENT","CURRENCY_NOT_SUPPORTED","PURPOSE_NOT_SUPPORTED","PAYMENT_EXPIRED","SCHEME_CUT_OFF","UNDEFINED"],"description":"Details of the payment failure","example":"AML_BLOCKED_OUTBOUND_TRANSFER","nullable":true},"createdOn":{"format":"date-time","type":"string","description":"Timestamp when the card funding was created"},"transaction":{"nullable":true,"description":"Transaction associated with the card funding, if available","allOf":[{"$ref":"#/components/schemas/PartnerCardTransactionResponse"}]},"initiationRequest":{"description":"Original request payload that initiated the payment","oneOf":[{"$ref":"#/components/schemas/PartnerPaymentInternalPayload"},{"$ref":"#/components/schemas/PartnerPaymentExternalPayload"},{"$ref":"#/components/schemas/PartnerPaymentFundingInitiatePayload"},{"$ref":"#/components/schemas/PartnerCardFundingInitiatePayload"}]}},"required":["paymentId","processingState","createdOn","initiationRequest"]},"PartnerAutomatedPaymentCounterpartyMetadataRequest":{"type":"object","properties":{"name":{"type":"string","nullable":true,"description":"Display name of the originator used as supplemental direct debit metadata.","example":"COMPANY LTD"},"serviceUserNumber":{"type":"string","description":"BACS service user number associated with the direct debit originator.","example":"123456"}},"required":["serviceUserNumber"]},"PartnerSimulateDirectDebitMandateRequest":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","description":"Identifier of the customer's account that will be debited by this automated payment."},"reference":{"type":"string","description":"Partner reference for the automated payment instruction.","example":"UTILITY-BILL-MAY"},"counterparty":{"description":"Counterparty account and identity details for the automated payment instruction.","oneOf":[{"$ref":"#/components/schemas/PartnerPaymentReferenceCounterpartyPayload"}],"allOf":[{"$ref":"#/components/schemas/PartnerPaymentReferenceCounterpartyPayload"}]},"metadata":{"description":"Originator metadata used for direct debit setup and partner display.","allOf":[{"$ref":"#/components/schemas/PartnerAutomatedPaymentCounterpartyMetadataRequest"}]}},"required":["accountId","reference","counterparty","metadata"]},"PartnerSimulateDirectDebitPaymentRequest":{"type":"object","properties":{"automatedPaymentId":{"type":"string","format":"uuid","description":"Identifier of the automated payment."},"accountId":{"type":"string","format":"uuid","description":"Identifier of the customer's account that will receive the simulated collection.","example":"e0cab2dd-739f-43de-b131-3e423e935bf1"},"amount":{"type":"number","maxLength":11,"description":"Amount of the simulated direct debit collection in minor units.","example":1250},"reference":{"type":"string","maxLength":18,"description":"Reference that will be included in the simulated direct debit record.","example":"MAYUTILITYBILL"}},"required":["automatedPaymentId","accountId","amount"]},"PartnerSimulateDirectCreditPaymentRequest":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","description":"Identifier of the customer's account that will receive the simulated direct credit.","example":"e0cab2dd-739f-43de-b131-3e423e935bf1"},"amount":{"type":"number","minimum":1,"maximum":99999999999,"description":"Amount of the simulated direct credit in minor units (e.g. for £1.29 enter 129).","example":15000},"reference":{"type":"string","maxLength":18,"description":"Reference that will be included in the simulated direct credit record. Generated when omitted.","example":"SALARY OCT"},"originatorName":{"type":"string","maxLength":18,"description":"Name of the originator (payer) account.","default":"HORIZON SIMULATION","example":"ACME LTD"},"originatorSortCode":{"type":"string","minLength":6,"maxLength":6,"description":"Sort code of the originator (payer) account.","default":"400516","example":"400516"},"originatorAccountNumber":{"type":"string","minLength":8,"maxLength":8,"description":"Account number of the originator (payer) account.","default":"12345678","example":"12345678"},"serviceUserNumber":{"type":"string","minLength":6,"maxLength":6,"description":"BACS service user number of the originator.","default":"400000","example":"400000"}},"required":["accountId","amount"]},"PartnerAddressFreeformResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["STRUCTURED","FREEFORM"]},"line1":{"type":"string","example":""},"line2":{"type":"string","example":""},"line3":{"type":"string","example":""},"state":{"type":"string","example":"TX","description":"Two character state code, when country is USA this field is required"},"postcode":{"type":"string","example":"SW1A 2AB"},"country":{"type":"string","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"],"example":"GBR"}},"required":["id","type","line1","line2","line3","state","postcode","country"]},"PartnerAddressStructuredResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["STRUCTURED","FREEFORM"]},"flatNumber":{"type":"string","example":""},"buildingNumber":{"type":"string","example":"10"},"buildingName":{"type":"string","example":""},"street":{"type":"string","example":"Downling"},"subStreet":{"type":"string","example":""},"town":{"type":"string","example":"London"},"state":{"type":"string","example":"TX","description":"Two character state code, when country is USA this field is required"},"postcode":{"type":"string","example":"SW1A 2AB"},"country":{"type":"string","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"],"example":"GBR"}},"required":["id","type","flatNumber","buildingNumber","buildingName","street","subStreet","town","state","postcode","country"]},"PartnerPersonalProspectResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the prospect","example":"a2b9649e-df7f-4349-adff-1c57283fef10"},"externalReference":{"type":"string","description":"External unique reference on partners platform","nullable":true},"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"James","nullable":true},"lastName":{"type":"string","example":"Doe"},"email":{"type":"string","example":"john.doe@algbra.com"},"address":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/PartnerAddressFreeformResponse"},{"$ref":"#/components/schemas/PartnerAddressStructuredResponse"}]},"dateOfBirth":{"type":"string","format":"date"},"phoneNumber":{"type":"string","example":"+447101231111"},"onboardingState":{"type":"string","enum":["IDLE","VERIFICATION_PENDING","PROVIDING_KYC_DATA","AWAITING_QUESTIONNAIRE","COLLECT_DOCS","UNDER_REVIEW","AWAITING_KYC_RESULT","KYC_FAILED","AWAITING_CUSTOMER_CREATION","ONBOARDED","ONBOARDING_FAILED","DUPLICATE_KYC_DATA","REJECTED","UNKNOWN"]},"createDate":{"format":"date-time","type":"string"}},"required":["id","firstName","lastName","email","dateOfBirth","phoneNumber","onboardingState","createDate"]},"PartnerOnboardingStateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"state":{"type":"string","enum":["IDLE","VERIFICATION_PENDING","PROVIDING_KYC_DATA","AWAITING_QUESTIONNAIRE","COLLECT_DOCS","UNDER_REVIEW","AWAITING_KYC_RESULT","KYC_FAILED","AWAITING_CUSTOMER_CREATION","ONBOARDED","ONBOARDING_FAILED","DUPLICATE_KYC_DATA","REJECTED","UNKNOWN"]},"createDate":{"format":"date-time","type":"string"}},"required":["id","state","createDate"]},"PartnerPersonalProspectDetailedResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the prospect","example":"a2b9649e-df7f-4349-adff-1c57283fef10"},"externalReference":{"type":"string","description":"External unique reference on partners platform","nullable":true},"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"James","nullable":true},"lastName":{"type":"string","example":"Doe"},"email":{"type":"string","example":"john.doe@algbra.com"},"address":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/PartnerAddressFreeformResponse"},{"$ref":"#/components/schemas/PartnerAddressStructuredResponse"}]},"dateOfBirth":{"type":"string","format":"date"},"phoneNumber":{"type":"string","example":"+447101231111"},"onboardingState":{"type":"string","enum":["IDLE","VERIFICATION_PENDING","PROVIDING_KYC_DATA","AWAITING_QUESTIONNAIRE","COLLECT_DOCS","UNDER_REVIEW","AWAITING_KYC_RESULT","KYC_FAILED","AWAITING_CUSTOMER_CREATION","ONBOARDED","ONBOARDING_FAILED","DUPLICATE_KYC_DATA","REJECTED","UNKNOWN"]},"createDate":{"format":"date-time","type":"string"},"identificationNumber":{"type":"string","example":"","nullable":true},"onboardingStates":{"type":"array","items":{"$ref":"#/components/schemas/PartnerOnboardingStateResponse"}}},"required":["id","firstName","lastName","email","dateOfBirth","phoneNumber","onboardingState","createDate","onboardingStates"]},"PartnerAddressFreeformRequest":{"type":"object","properties":{"type":{"type":"string","enum":["STRUCTURED","FREEFORM"]},"line1":{"type":"string","example":"","nullable":true,"maxLength":50},"line2":{"type":"string","example":"","nullable":true,"maxLength":50},"line3":{"type":"string","example":"","nullable":true,"maxLength":50},"state":{"type":"string","example":"","nullable":true},"postcode":{"type":"string","example":"SW1A 2AB"},"country":{"type":"string","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"],"example":"GBR"}},"required":["type","postcode","country"]},"PartnerAddressStructuredRequest":{"type":"object","properties":{"type":{"type":"string","enum":["STRUCTURED","FREEFORM"]},"flatNumber":{"type":"string","example":"","nullable":true,"maxLength":25},"buildingNumber":{"type":"string","example":"10","nullable":true,"maxLength":25},"buildingName":{"type":"string","example":"","nullable":true,"maxLength":50},"street":{"type":"string","example":"Downling","nullable":true,"maxLength":50},"subStreet":{"type":"string","example":"","nullable":true,"maxLength":50},"town":{"type":"string","example":"London","nullable":true,"maxLength":50},"state":{"type":"string","example":"","nullable":true,"maxLength":50},"postcode":{"type":"string","example":"SW1A 2AB"},"country":{"type":"string","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"],"example":"GBR"}},"required":["type","postcode","country"]},"PartnerCreatePersonalProspectRequest":{"type":"object","properties":{"externalReference":{"type":"string","description":"External unique prospect reference on partners platform","nullable":true},"externalAccountReference":{"type":"string","description":"External unique account reference on partners platform","nullable":true},"firstName":{"type":"string","example":"John"},"middleName":{"type":"string","example":"James","nullable":true},"lastName":{"type":"string","example":"Doe"},"email":{"type":"string","example":"john.doe@algbra.com"},"address":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/PartnerAddressFreeformRequest"},{"$ref":"#/components/schemas/PartnerAddressStructuredRequest"}]},"dateOfBirth":{"type":"string","format":"date"},"phoneNumber":{"type":"string","example":"+447101231111","description":"Phone number with no special characters or spaces"},"identificationNumber":{"type":"string","example":"","nullable":true,"description":"National Id Number, SSN or similar"}},"required":["email"]},"PartnerUpdatePersonalProspectRequest":{"type":"object","properties":{"firstName":{"type":"string","example":"John","nullable":true},"middleName":{"type":"string","example":"James","nullable":true},"lastName":{"type":"string","example":"Doe","nullable":true},"email":{"type":"string","example":"john.doe@algbra.com","nullable":true},"address":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/PartnerAddressFreeformRequest"},{"$ref":"#/components/schemas/PartnerAddressStructuredRequest"}]},"dateOfBirth":{"type":"string","format":"date","nullable":true},"phoneNumber":{"type":"string","example":"+447101231111","nullable":true,"description":"Phone number with no special characters or spaces"},"identificationNumber":{"type":"string","example":"","nullable":true,"description":"National Id Number, SSN or similar"}}},"PartnerQuestionnaireQuestionAnswerRequest":{"type":"object","properties":{"entityId":{"type":"string","description":"Unique entityId identifier (prospect or customer id)","format":"uuid"},"source":{"type":"string","enum":["NONE","ONBOARDING","PERIODIC_REVIEW","CUSTOMER_TASK"]},"sourceId":{"type":"string","nullable":true},"answers":{"type":"array","items":{"$ref":"#/components/schemas/PartnerQuestionnaireQuestionAnswer"}}},"required":["entityId","source","sourceId","answers"]},"PartnerStartPersonalComplianceChecksRequest":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PartnerComplianceCheckItem"}}},"required":["items"]},"PartnerBusinessProspectResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the prospect","example":"a2b9649e-df7f-4349-adff-1c57283fef10"},"externalReference":{"type":"string","description":"External unique reference on partners platform","nullable":true},"legalEntityName":{"type":"string","example":"Algbra Group Limited"},"legalEntityType":{"type":"string","example":"LIMITED_COMPANY","enum":["SOLE_TRADER","UNINCORPORATED_ASSOCIATION","PARTNERSHIP","LIMITED_PARTNERSHIP","TRUST","LIMITED_COMPANY","LIMITED_LIABILITY_PARTNERSHIP","COMMUNITY_INTEREST_COMPANY","CHARITABLE_INCORPORATED_ORGANIZATION","CO_OPERATIVE_SOCIETY","COMMUNITY_BENEFIT_SOCIETY","BUILDING_SOCIETY_BUILDING","CREDIT_UNION","FRIENDLY_SOCIETY"]},"email":{"type":"string","example":"john.doe@algbra.com"},"phoneNumber":{"type":"string","example":"+447101231111"},"address":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/PartnerAddressFreeformResponse"},{"$ref":"#/components/schemas/PartnerAddressStructuredResponse"}]},"onboardingState":{"type":"string","enum":["IDLE","VERIFICATION_PENDING","PROVIDING_KYC_DATA","AWAITING_QUESTIONNAIRE","COLLECT_DOCS","UNDER_REVIEW","AWAITING_KYC_RESULT","KYC_FAILED","AWAITING_CUSTOMER_CREATION","ONBOARDED","ONBOARDING_FAILED","DUPLICATE_KYC_DATA","REJECTED","UNKNOWN"]},"createDate":{"format":"date-time","type":"string"}},"required":["id","legalEntityName","legalEntityType","email","phoneNumber","onboardingState","createDate"]},"PartnerBusinessDirectorPayload":{"type":"object","properties":{"firstName":{"type":"string","example":"John","nullable":true},"middleName":{"type":"string","example":"James","nullable":true},"lastName":{"type":"string","example":"Doe","nullable":true},"dateOfBirth":{"type":"string","format":"date","nullable":true}}},"PartnerBusinessProspectDetailedResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the prospect","example":"a2b9649e-df7f-4349-adff-1c57283fef10"},"externalReference":{"type":"string","description":"External unique reference on partners platform","nullable":true},"legalEntityName":{"type":"string","example":"Algbra Group Limited"},"legalEntityType":{"type":"string","example":"LIMITED_COMPANY","enum":["SOLE_TRADER","UNINCORPORATED_ASSOCIATION","PARTNERSHIP","LIMITED_PARTNERSHIP","TRUST","LIMITED_COMPANY","LIMITED_LIABILITY_PARTNERSHIP","COMMUNITY_INTEREST_COMPANY","CHARITABLE_INCORPORATED_ORGANIZATION","CO_OPERATIVE_SOCIETY","COMMUNITY_BENEFIT_SOCIETY","BUILDING_SOCIETY_BUILDING","CREDIT_UNION","FRIENDLY_SOCIETY"]},"email":{"type":"string","example":"john.doe@algbra.com"},"phoneNumber":{"type":"string","example":"+447101231111"},"address":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/PartnerAddressFreeformResponse"},{"$ref":"#/components/schemas/PartnerAddressStructuredResponse"}]},"onboardingState":{"type":"string","enum":["IDLE","VERIFICATION_PENDING","PROVIDING_KYC_DATA","AWAITING_QUESTIONNAIRE","COLLECT_DOCS","UNDER_REVIEW","AWAITING_KYC_RESULT","KYC_FAILED","AWAITING_CUSTOMER_CREATION","ONBOARDED","ONBOARDING_FAILED","DUPLICATE_KYC_DATA","REJECTED","UNKNOWN"]},"createDate":{"format":"date-time","type":"string"},"director":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerBusinessDirectorPayload"}]},"identificationNumber":{"type":"string","description":"National Id Number, SSN or similar","example":"","nullable":true},"onboardingStates":{"type":"array","items":{"$ref":"#/components/schemas/PartnerOnboardingStateResponse"}}},"required":["id","legalEntityName","legalEntityType","email","phoneNumber","onboardingState","createDate","onboardingStates"]},"PartnerCreateBusinessProspectRequest":{"type":"object","properties":{"externalReference":{"type":"string","description":"External unique prospect reference on partners platform","nullable":true},"externalAccountReference":{"type":"string","description":"External unique account reference on partners platform","nullable":true},"legalEntityName":{"type":"string","example":"Algbra Group Limited"},"legalEntityType":{"type":"string","example":"LIMITED_COMPANY","enum":["SOLE_TRADER","UNINCORPORATED_ASSOCIATION","PARTNERSHIP","LIMITED_PARTNERSHIP","TRUST","LIMITED_COMPANY","LIMITED_LIABILITY_PARTNERSHIP","COMMUNITY_INTEREST_COMPANY","CHARITABLE_INCORPORATED_ORGANIZATION","CO_OPERATIVE_SOCIETY","COMMUNITY_BENEFIT_SOCIETY","BUILDING_SOCIETY_BUILDING","CREDIT_UNION","FRIENDLY_SOCIETY"]},"email":{"type":"string","example":"john.doe@algbra.com"},"address":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/PartnerAddressFreeformRequest"},{"$ref":"#/components/schemas/PartnerAddressStructuredRequest"}]},"phoneNumber":{"type":"string","example":"+447101231111","description":"Phone number with no special characters or spaces","nullable":true},"identificationNumber":{"type":"string","example":"","nullable":true,"description":"National Id Number, SSN or similar"},"director":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerBusinessDirectorPayload"}]}},"required":["legalEntityName","legalEntityType","email"]},"PartnerUpdateBusinessProspectRequest":{"type":"object","properties":{"legalEntityName":{"type":"string","example":"Algbra Group Limited","nullable":true},"legalEntityType":{"type":"string","example":"LIMITED_COMPANY","enum":["SOLE_TRADER","UNINCORPORATED_ASSOCIATION","PARTNERSHIP","LIMITED_PARTNERSHIP","TRUST","LIMITED_COMPANY","LIMITED_LIABILITY_PARTNERSHIP","COMMUNITY_INTEREST_COMPANY","CHARITABLE_INCORPORATED_ORGANIZATION","CO_OPERATIVE_SOCIETY","COMMUNITY_BENEFIT_SOCIETY","BUILDING_SOCIETY_BUILDING","CREDIT_UNION","FRIENDLY_SOCIETY"],"nullable":true},"email":{"type":"string","example":"john.doe@algbra.com","nullable":true},"address":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/PartnerAddressFreeformRequest"},{"$ref":"#/components/schemas/PartnerAddressStructuredRequest"}]},"phoneNumber":{"type":"string","example":"+447101231111","nullable":true,"description":"Phone number with no special characters or spaces"},"identificationNumber":{"type":"string","example":"","nullable":true,"description":"National Id Number, SSN or similar"},"director":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerBusinessDirectorPayload"}]}}},"QuestionnaireQuestionOption":{"type":"object","properties":{"key":{"type":"object"},"text":{"type":"string"},"value":{"type":"object","nullable":true},"inputType":{"type":"string","enum":["NUMBER","TEXT"],"nullable":true},"hidden":{"type":"boolean","nullable":true}},"required":["key","text","value","inputType"]},"PartnerQuestionnaireQuestionResponse":{"type":"object","properties":{"key":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["CHECKBOX","RADIO","TEXT","MULTI_LINE_TEXT","COUNTRY_PICKER","TAX_RESIDENCY"]},"options":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/QuestionnaireQuestionOption"}},"maxSelection":{"type":"number","nullable":true},"optional":{"type":"boolean","nullable":true}},"required":["key","title","description","type","options","maxSelection","optional"]},"PartnerQuestionnaireQuestionAnswerResponse":{"type":"object","properties":{"questionnaireKey":{"type":"string"},"questionKey":{"type":"string"},"options":{"nullable":true,"type":"array","items":{"type":"string"}},"text":{"type":"string","nullable":true}},"required":["questionnaireKey","questionKey","options","text"]},"PartnerQuestionnaireResponse":{"type":"object","properties":{"questions":{"$ref":"#/components/schemas/PartnerQuestionnaireQuestionResponse"},"answers":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PartnerQuestionnaireQuestionAnswerResponse"}]}},"required":["questions","answers"]},"PartnerQuestionnaireQuestionAnswer":{"type":"object","properties":{"questionKey":{"type":"string"},"options":{"nullable":true,"type":"array","items":{"type":"string"}},"text":{"type":"string","nullable":true}},"required":["questionKey","options","text"]},"PartnerDueDiligenceItemAttributeDetail":{"type":"object","properties":{"key":{"type":"string","enum":["PEP","SANCTION","ADVERSE_MEDIA","COUNTRY_OF_RESIDENCE","ID_DOCUMENT","NATIONALITY","PLACE_OF_BIRTH","ANTI_IMPERSONATION","LEGAL_WARNINGS","AUTO_KYC_RESOLUTION","RISK_SCORE_OVERRIDE","RISK_SCORE_CALCULATED","EXPECTED_ANNUAL_INCOME","NFD","INTELLIGENCE"]},"valid":{"type":"boolean"},"available":{"type":"boolean"},"input":{"type":"string","enum":["REQUIRED","OPTIONAL"]},"informative":{"type":"boolean","description":"When true, this attribute is informative only and processed internally by the platform."}},"required":["key","valid","available","input","informative"]},"PartnerDueDiligenceItem":{"type":"object","properties":{"required":{"type":"boolean"},"valid":{"type":"boolean","nullable":true},"attributes":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/PartnerDueDiligenceItemAttributeDetail"}}},"required":["required","attributes"]},"PartnerPersonalProspectDueDiligenceDetails":{"type":"object","properties":{"ADDRESS_PROOF":{"$ref":"#/components/schemas/PartnerDueDiligenceItem"},"ANTI_IMPERSONATION":{"$ref":"#/components/schemas/PartnerDueDiligenceItem"},"FUND_PROOF":{"$ref":"#/components/schemas/PartnerDueDiligenceItem"},"ID_PROOF":{"$ref":"#/components/schemas/PartnerDueDiligenceItem"},"PROOF_OF_MEDIA_SCREENING":{"$ref":"#/components/schemas/PartnerDueDiligenceItem"},"LEGAL_WARNINGS_EXPLANATION":{"$ref":"#/components/schemas/PartnerDueDiligenceItem"},"BACKGROUND_CHECK":{"$ref":"#/components/schemas/PartnerDueDiligenceItem"},"SANCTION":{"$ref":"#/components/schemas/PartnerDueDiligenceItem"}},"required":["ADDRESS_PROOF","ANTI_IMPERSONATION","FUND_PROOF","ID_PROOF","PROOF_OF_MEDIA_SCREENING","LEGAL_WARNINGS_EXPLANATION","BACKGROUND_CHECK","SANCTION"]},"PartnerPersonalProspectDueDiligenceInfo":{"type":"object","properties":{"clear":{"type":"string","enum":["VERIFIED","FAILED"]},"details":{"$ref":"#/components/schemas/PartnerPersonalProspectDueDiligenceDetails"}},"required":["clear","details"]},"PartnerComplianceCheckItemEvidence":{"type":"object","properties":{"externalEvidenceId":{"type":"string","example":"123456789"},"type":{"type":"string","enum":["BILL","PASSPORT","RESIDENCY_PERMIT","BIRTH_CERTIFICATE","ID_CARD","BANK_STATEMENT","TAX_RETURNS","ACCOUNTING_DOCS","FACE_RECORDING","VOTER_ID","DRIVING_LICENCE","WORK_PERMIT","OTHER","DRIVING_LICENSE","EGOV_DOC","UK_SHARE_CODE"]},"providedBy":{"type":"string","enum":["CUSTOMER","PARTNER"]},"issuingCountry":{"type":"string","enum":["AFG","ALA","ALB","DZA","ASM","AND","AGO","AIA","ATA","ATG","ARG","ARM","ABW","AUS","AUT","AZE","BHS","BHR","BGD","BRB","BLR","BEL","BLZ","BEN","BMU","BTN","BOL","BES","BIH","BWA","BVT","BRA","IOT","BRN","BGR","BFA","BDI","CPV","KHM","CMR","CAN","CYM","CAF","TCD","CHL","CHN","CXR","CCK","COL","COM","COG","COD","COK","CRI","CIV","HRV","CUB","CUW","CYP","CZE","DNK","DJI","DMA","DOM","ECU","EGY","SLV","GNQ","ERI","EST","SWZ","ETH","FLK","FRO","FJI","FIN","FRA","GUF","PYF","ATF","GAB","GMB","GEO","DEU","GHA","GIB","GRC","GRL","GRD","GLP","GUM","GTM","GGY","GIN","GNB","GUY","HTI","HMD","VAT","HND","HKG","HUN","ISL","IND","IDN","IRN","IRQ","IRL","IMN","ISR","ITA","JAM","JPN","JEY","JOR","KAZ","KEN","KIR","PRK","KOR","KWT","KGZ","LAO","LVA","LBN","LSO","LBR","LBY","LIE","LTU","LUX","MAC","MDG","MWI","MYS","MDV","MLI","MLT","MHL","MTQ","MRT","MUS","MYT","MEX","FSM","MDA","MCO","MNG","MNE","MSR","MAR","MOZ","MMR","NAM","NRU","NPL","NLD","NCL","NZL","NIC","NER","NGA","NIU","NFK","MKD","MNP","NOR","OMN","PAK","PLW","PSE","PAN","PNG","PRY","PER","PHL","PCN","POL","PRT","PRI","QAT","REU","ROU","RUS","RWA","BLM","SHN","KNA","LCA","MAF","SPM","VCT","WSM","SMR","STP","SAU","SEN","SRB","SYC","SLE","SGP","SXM","SVK","SVN","SLB","SOM","ZAF","SGS","SSD","ESP","LKA","SDN","SUR","SJM","SWE","CHE","SYR","TWN","TJK","TZA","THA","TLS","TGO","TKL","TON","TTO","TUN","TUR","TKM","TCA","TUV","UGA","UKR","ARE","GBR","USA","UMI","URY","UZB","VUT","VEN","VNM","VGB","VIR","WLF","ESH","YEM","ZMB","ZWE","XXK","XKX"],"example":"GBR"},"side":{"type":"string","enum":["FRONT","BACK"]},"kind":{"type":"string","enum":["IMAGE","VIDEO"]}},"required":["externalEvidenceId","type","providedBy","kind"]},"PartnerComplianceCheckItemEvidenceExternal":{"type":"object","properties":{"externalEvidenceId":{"type":"string","example":"123456789"},"externalProvider":{"type":"string","example":"ONFIDO"}},"required":["externalEvidenceId","externalProvider"]},"PartnerComplianceCheckItem":{"type":"object","properties":{"key":{"type":"object","description":"Required attribute key","example":true},"verified":{"type":"boolean","description":"Indicates where the verification result is successful","example":true},"processType":{"type":"string","description":"Indicates where a verification decision is made automatically or manually","enum":["MANUAL","AUTOMATIC"]},"remarks":{"description":"Additional comments about the compliance check item","example":["Prospective customer provided multiple bank statements as address proof from AAA Bank and BBB Financial institution","The customer manually provided a passport scan after the automated check failed with the expired ID document"],"type":"array","items":{"type":"array"}},"properties":{"nullable":true,"description":"Supplementary data from the verification documents","example":[{"key":"passport_number","value":"ALG123456"}],"type":"array","items":{"type":"array"}},"evidence":{"type":"array","nullable":true,"items":{"oneOf":[{"$ref":"#/components/schemas/PartnerComplianceCheckItemEvidence"},{"$ref":"#/components/schemas/PartnerComplianceCheckItemEvidenceExternal"}]}}},"required":["key","verified","processType","remarks"]}}}}