{"items":[{"type":"link","label":"Weavr Embedded Payment Run API","link":"/products/payment-run/openapi","routeSlug":"/products/payment-run/openapi"},{"type":"link","label":"Authentication","link":"/products/payment-run/openapi/section/authentication","routeSlug":"/products/payment-run/openapi/section/authentication"},{"type":"link","label":"Postman Collection","link":"/products/payment-run/openapi/section/postman-collection","routeSlug":"/products/payment-run/openapi/section/postman-collection"},{"type":"separator","label":"Authentication"},{"type":"group","label":"Tokens","link":"/products/payment-run/openapi/tokens","routeSlug":"/products/payment-run/openapi/tokens","items":[{"label":"Acquire auth token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/tokens/acquireauthtoken","routeSlug":"/products/payment-run/openapi/tokens/acquireauthtoken","metadata":{"seo":{"title":"Acquire auth token","description":"Authenticate a user with the email and password that they provided when registering."}},"httpPath":"/v1/login_with_password"},{"label":"Logout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/tokens/logout","routeSlug":"/products/payment-run/openapi/tokens/logout","metadata":{"seo":{"title":"Logout","description":"Logs out the user and terminates the session identified by theauth_token in the Authorization Header."}},"httpPath":"/v1/logout"}]},{"type":"group","label":"Passwords","link":"/products/payment-run/openapi/passwords","routeSlug":"/products/payment-run/openapi/passwords","items":[{"label":"Create a password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/passwords/passwordcreate","routeSlug":"/products/payment-run/openapi/passwords/passwordcreate","metadata":{"seo":{"title":"Create a password","description":"Create a new password for the user identified by the user_id path parameter."}},"httpPath":"/v1/password/{user_id}"},{"label":"Update a password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/passwords/passwordupdate","routeSlug":"/products/payment-run/openapi/passwords/passwordupdate","metadata":{"seo":{"title":"Update a password","description":"Update the password for the logged-in user."}},"httpPath":"/v1/passwords/update"},{"label":"Validate a password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/passwords/passwordvalidate","routeSlug":"/products/payment-run/openapi/passwords/passwordvalidate","metadata":{"seo":{"title":"Validate a password","description":"Check that a password adheres to all complexity checks."}},"httpPath":"/v1/passwords/validate"},{"label":"Initiate lost password process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/passwords/lostpasswordinitiate","routeSlug":"/products/payment-run/openapi/passwords/lostpasswordinitiate","metadata":{"seo":{"title":"Initiate lost password process","description":"Initiate the lost password process."}},"httpPath":"/v1/passwords/lost_password/start"},{"label":"Resume lost password process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/passwords/lostpasswordresume","routeSlug":"/products/payment-run/openapi/passwords/lostpasswordresume","metadata":{"seo":{"title":"Resume lost password process","description":"This is the second and final step in updating the password of a user who forgot their password."}},"httpPath":"/v1/passwords/lost_password/resume"}]},{"type":"separator","label":"Authorisation"},{"type":"group","label":"Additional Factors","link":"/products/payment-run/openapi/additional-factors","routeSlug":"/products/payment-run/openapi/additional-factors","items":[{"label":"Enrol a user device for authentication using one-time passwords","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/additional-factors/enroldeviceusingotpstepone","routeSlug":"/products/payment-run/openapi/additional-factors/enroldeviceusingotpstepone","metadata":{"seo":{"title":"Enrol a user device for authentication using one-time passwords","description":"This is the first step in enrolling the logged-in user's mobile device, where a one-time password is sent to the device."}},"httpPath":"/v1/authentication_factors/otp/{channel}"},{"label":"Verify enrolment of a user device for authentication using one-time passwords","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/additional-factors/enroldeviceusingotpsteptwo","routeSlug":"/products/payment-run/openapi/additional-factors/enroldeviceusingotpsteptwo","metadata":{"seo":{"title":"Verify enrolment of a user device for authentication using one-time passwords","description":"The second step in enrolling the logged-in user (root or authorised user) to use one-time-passwords to enable verification of transactions."}},"httpPath":"/v1/authentication_factors/otp/{channel}/verify"}]},{"type":"group","label":"Step up","link":"/products/payment-run/openapi/step-up","routeSlug":"/products/payment-run/openapi/step-up","items":[{"label":"Issue a one-time password that can be used to step-up a token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/step-up/stepupscachallenge","routeSlug":"/products/payment-run/openapi/step-up/stepupscachallenge","metadata":{"seo":{"title":"Issue a one-time password that can be used to step-up a token","description":"Initiates the step-up token process by sending an SMS with an one-time-password to a device belonging to the logged-in user that was previously enrolled through /authentication_factors/otp/{channel} endpoint."}},"httpPath":"/v1/stepup/challenges/otp/{channel}"},{"label":"Verify a step-up token using a one-time password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/step-up/stepupscaverify","routeSlug":"/products/payment-run/openapi/step-up/stepupscaverify","metadata":{"seo":{"title":"Verify a step-up token using a one-time password","description":"Completes the verification process for a step up token."}},"httpPath":"/v1/stepup/challenges/otp/{channel}/verify"}]},{"type":"separator","label":"Identities"},{"type":"group","label":"Buyers","link":"/products/payment-run/openapi/buyers","routeSlug":"/products/payment-run/openapi/buyers","items":[{"label":"Create a buyer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyers/buyercreate","routeSlug":"/products/payment-run/openapi/buyers/buyercreate","metadata":{"seo":{"title":"Create a buyer","description":"Buyers are identities representing a business. Once on-boarded, Buyers can create and manage their own instruments via your plugin."}},"httpPath":"/v1/buyers"},{"label":"Get buyer details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyers/buyerget","routeSlug":"/products/payment-run/openapi/buyers/buyerget","metadata":{"seo":{"title":"Get buyer details","description":"Retrieve the details of the buyer that the logged-in user belongs to."}},"httpPath":"/v1/buyers"},{"label":"Update a buyer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyers/buyerupdate","routeSlug":"/products/payment-run/openapi/buyers/buyerupdate","metadata":{"seo":{"title":"Update a buyer","description":"Update the buyer currencies and admin roles."}},"httpPath":"/v1/buyers"},{"label":"Start admin user email verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyers/buyeradminuseremailverificationcodesend","routeSlug":"/products/payment-run/openapi/buyers/buyeradminuseremailverificationcodesend","metadata":{"seo":{"title":"Start admin user email verification","description":"The first step in verifying a admin user's email. The admin user whose email address is to be verified is sent an email containing a randomly generated code."}},"httpPath":"/v1/buyers/verification/email/send"},{"label":"Verify admin user email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyers/buyeradminuseremailverify","routeSlug":"/products/payment-run/openapi/buyers/buyeradminuseremailverify","metadata":{"seo":{"title":"Verify admin user email","description":"The second step in verifying the admin user's email. The randomly generated code sent to the admin user viaemail, using the buyerAdminUserEmailVerificationCodeSend operation, is submitted here to verify the admin user's email."}},"httpPath":"/v1/buyers/verification/email/verify"},{"label":"Start buyer KYB","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyers/buyerkybstart","routeSlug":"/products/payment-run/openapi/buyers/buyerkybstart","metadata":{"seo":{"title":"Start buyer KYB","description":"Buyers need to complete due diligence (KYB) before they can create payment runs and pay their suppliers."}},"httpPath":"/v1/buyers/kyb"},{"label":"Get buyer KYB status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyers/buyerkybget","routeSlug":"/products/payment-run/openapi/buyers/buyerkybget","metadata":{"seo":{"title":"Get buyer KYB status","description":"Returns the KYB status for the buyer that the logged-in user belongs to."}},"httpPath":"/v1/buyers/kyb"},{"label":"Update Buyer's KYB details","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyers/buyerupdatekyb","routeSlug":"/products/payment-run/openapi/buyers/buyerupdatekyb","metadata":{"seo":{"title":"Update Buyer's KYB details","description":"Update the details of the buyer that the logged-in user belongs to."}},"httpPath":"/v1/buyers/kyb"}]},{"type":"group","label":"Buyer Authorised Users","link":"/products/payment-run/openapi/buyer-authorised-users","routeSlug":"/products/payment-run/openapi/buyer-authorised-users","items":[{"label":"Create a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/usercreate","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/usercreate","metadata":{"seo":{"title":"Create a user","description":"Creates a user that belongs to the buyer that the logged-in user belongs to. To Create an Authorised User you would need a stepped-up token. After calling this endpoint you need to step-up ( issue a challenge /stepup/challenges/otp/{channel} ). More details on how to step-up a token can be found here Step-Up."}},"httpPath":"/v1/users"},{"label":"Get all users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/usersget","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/usersget","metadata":{"seo":{"title":"Get all users","description":"Fetches all authorised users associated with the buyer that the logged-in user belongs to."}},"httpPath":"/v1/users"},{"label":"Get a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/usergetbyid","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/usergetbyid","metadata":{"seo":{"title":"Get a user","description":"Retrieves the user identified by the user_id path parameter."}},"httpPath":"/v1/users/{user_id}"},{"label":"Update a user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/userupdate","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/userupdate","metadata":{"seo":{"title":"Update a user","description":"Update the details of a user identified by the user_id in the the path parameter. After calling this endpoint you need to step-up ( issue a challenge /stepup/challenges/otp/{channel} ). More details on how to step-up a token can be found here Step-Up.."}},"httpPath":"/v1/users/{user_id}"},{"label":"Activate a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/useractivate","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/useractivate","metadata":{"seo":{"title":"Activate a user","description":"Activate the user identified by the user_id path parameter."}},"httpPath":"/v1/users/{user_id}/activate"},{"label":"Deactivate a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/userdeactivate","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/userdeactivate","metadata":{"seo":{"title":"Deactivate a user","description":"De-activate the user identified by the user_id path parameter."}},"httpPath":"/v1/users/{user_id}/deactivate"},{"label":"Send a user invite","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/userinvitesend","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/userinvitesend","metadata":{"seo":{"title":"Send a user invite","description":"Once a user is created using the userCreate operation, the user needs to setup his/her password."}},"httpPath":"/v1/users/{user_id}/invite"},{"label":"Validate a user invite","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/userinvitevalidate","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/userinvitevalidate","metadata":{"seo":{"title":"Validate a user invite","description":"Check if a user's invite is still valid. This operation is useful to avoid having the user fill in a form only to be held by a validation issue (eg. expired invite)."}},"httpPath":"/v1/users/{user_id}/invite/validate"},{"label":"Consume a user invite","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/userinviteconsume","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/userinviteconsume","metadata":{"seo":{"title":"Consume a user invite","description":"Consumes an invitation previously sent to the user via userInviteSend. This is needed so that the invited user sets up the password."}},"httpPath":"/v1/users/{user_id}/invite/consume"},{"label":"Send an email verification code to the authorised user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/authoriseduseremailverificationcodesend","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/authoriseduseremailverificationcodesend","metadata":{"seo":{"title":"Send an email verification code to the authorised user","description":"The first step in verifying an authorised user's email. The authorised user whose email address is to be verified is sent an email containing a randomly generated code."}},"httpPath":"/v1/users/verification/email/send"},{"label":"Verify email of the authorised user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/buyer-authorised-users/authoriseduseremailverify","routeSlug":"/products/payment-run/openapi/buyer-authorised-users/authoriseduseremailverify","metadata":{"seo":{"title":"Verify email of the authorised user","description":"The second step in verifying the authorised user's email. The randomly generated code sent to the authorised user viaemail, using the authorisedUserEmailVerificationCodeSend operation, is submitted here to verify the authorised user's email."}},"httpPath":"/v1/users/verification/email/verify"}]},{"type":"separator","label":"Payment runs"},{"type":"group","label":"Payment runs","link":"/products/payment-run/openapi/payment-runs","routeSlug":"/products/payment-run/openapi/payment-runs","items":[{"label":"Create a payment run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/postpaymentrun","routeSlug":"/products/payment-run/openapi/payment-runs/postpaymentrun","metadata":{"seo":{"title":"Create a payment run","description":"Create a new payment run containing a list of outstanding supplier payments."}},"httpPath":"/v1/payment_runs"},{"label":"Get payment runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/getpaymentruns","routeSlug":"/products/payment-run/openapi/payment-runs/getpaymentruns","metadata":{"seo":{"title":"Get payment runs","description":"Retrieve the list of payment runs belonging to the buyer that the logged-in user belongs to."}},"httpPath":"/v1/payment_runs"},{"label":"Get a payment run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/getpaymentrunsid","routeSlug":"/products/payment-run/openapi/payment-runs/getpaymentrunsid","metadata":{"seo":{"title":"Get a payment run","description":"Retrieve a payment run belonging to the buyer that the logged-in user belongs to."}},"httpPath":"/v1/payment_runs/{payment_run_id}"},{"label":"Update a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/putpaymentrunsid","routeSlug":"/products/payment-run/openapi/payment-runs/putpaymentrunsid","metadata":{"seo":{"title":"Update a payment","description":"Update the details of a payment identified by the paymentId that is in the PENDING_CONFIRMATION state."}},"httpPath":"/v1/payment_runs/{payment_run_id}"},{"label":"Confirm a payment run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/postpaymentrunsidconfirm","routeSlug":"/products/payment-run/openapi/payment-runs/postpaymentrunsidconfirm","metadata":{"seo":{"title":"Confirm a payment run","description":"Confirm that a payment run can be executed."}},"httpPath":"/v1/payment_runs/{payment_run_id}/confirm"},{"label":"Get a payment run funding instructions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/getpaymentrunsidfund","routeSlug":"/products/payment-run/openapi/payment-runs/getpaymentrunsidfund","metadata":{"seo":{"title":"Get a payment run funding instructions","description":"Start the the funding process of a payment run."}},"httpPath":"/v1/payment_runs/{payment_run_id}/fund"},{"label":"Cancel a payment run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/postpaymentrunsidcancel","routeSlug":"/products/payment-run/openapi/payment-runs/postpaymentrunsidcancel","metadata":{"seo":{"title":"Cancel a payment run","description":"Cancel a payment run."}},"httpPath":"/v1/payment_runs/{payment_run_id}/cancel"},{"label":"Cancel a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/putcancelpaymentrunpayment","routeSlug":"/products/payment-run/openapi/payment-runs/putcancelpaymentrunpayment","metadata":{"seo":{"title":"Cancel a payment","description":"Cancel a payment within a payment run."}},"httpPath":"/v1/payment_runs/{payment_run_id}/cancel/payments"},{"label":"Restart a payment run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/postrestartpaymentrun","routeSlug":"/products/payment-run/openapi/payment-runs/postrestartpaymentrun","metadata":{"seo":{"title":"Restart a payment run","description":"Restart a payment run after it has entered status SCA_FAILED."}},"httpPath":"/v1/payment_runs/{payment_run_id}/restart"},{"label":"Cancel a payment run group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/payment-runs/postcancelpaymentrungroup","routeSlug":"/products/payment-run/openapi/payment-runs/postcancelpaymentrungroup","metadata":{"seo":{"title":"Cancel a payment run group","description":"Cancel a payment run groupNote that a payment run group can only be cancelled when it is in the state AWAITING_FUNDS."}},"httpPath":"/v1/payment_runs/{payment_run_id}/group/{group_reference}/cancel"}]},{"type":"separator","label":"Instruments"},{"type":"group","label":"Linked Accounts","link":"/products/payment-run/openapi/linked-accounts","routeSlug":"/products/payment-run/openapi/linked-accounts","items":[{"label":"Get Linked accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/linked-accounts/getlinkedaccounts","routeSlug":"/products/payment-run/openapi/linked-accounts/getlinkedaccounts","metadata":{"seo":{"title":"Get Linked accounts","description":"Retrieves the linked accounts belonging to the buyer that the logged-in user belongs to."}},"httpPath":"/v1/linked_accounts"},{"label":"Get Linked account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/linked-accounts/getlinkedaccountsid","routeSlug":"/products/payment-run/openapi/linked-accounts/getlinkedaccountsid","metadata":{"seo":{"title":"Get Linked account","description":"Retrieves a linked account of the buyer that the logged-in user belongs to."}},"httpPath":"/v1/linked_accounts/{linked_account_id}"},{"label":"Update a linked account","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/linked-accounts/patchlinkedaccountsid","routeSlug":"/products/payment-run/openapi/linked-accounts/patchlinkedaccountsid","metadata":{"seo":{"title":"Update a linked account","description":"Updates properties of a linked account such as friendly name."}},"httpPath":"/v1/linked_accounts/{linked_account_id}"},{"label":"Unlink a linked account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/linked-accounts/unlinklinkedaccountsid","routeSlug":"/products/payment-run/openapi/linked-accounts/unlinklinkedaccountsid","metadata":{"seo":{"title":"Unlink a linked account","description":"Unlinks a linked account identified by the linked_account_id."}},"httpPath":"/v1/linked_accounts/{linked_account_id}/unlink"}]},{"type":"separator","label":"Institutions"},{"type":"group","label":"Institutions","link":"/products/payment-run/openapi/institutions","routeSlug":"/products/payment-run/openapi/institutions","items":[{"label":"Get Institutions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/institutions/getinstitutions","routeSlug":"/products/payment-run/openapi/institutions/getinstitutions","metadata":{"seo":{"title":"Get Institutions","description":"Retrieves the Institutions supported by Embedded Payment Run. The response payload should list all the institutions."}},"httpPath":"/v1/institutions"}]},{"type":"separator","label":"Simulators"},{"type":"group","label":"Simulator","link":"/products/payment-run/openapi/simulator","routeSlug":"/products/payment-run/openapi/simulator","items":[{"label":"Simulate Fund a Payment run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/simulator/postfundpaymentrungroup","routeSlug":"/products/payment-run/openapi/simulator/postfundpaymentrungroup","metadata":{"seo":{"title":"Simulate Fund a Payment run","description":"Simulate funding a payment run using a linked account."}},"httpPath":"/simulate/v1/payment_runs/{payment_run_id}/fund_group/{reference}"},{"label":"Simulate Creating a Linked Account via Open Banking","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/simulator/postlinkedaccounts","routeSlug":"/products/payment-run/openapi/simulator/postlinkedaccounts","metadata":{"seo":{"title":"Simulate Creating a Linked Account via Open Banking","description":"The Linked Account Simulator allows you to create a simulated linked account that can be used for funding payment runs."}},"httpPath":"/simulate/v1/linked_accounts"},{"label":"Simulate Control Check via Test Funding Transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/simulator/postsimulatelinkedaccountfundverification","routeSlug":"/products/payment-run/openapi/simulator/postsimulatelinkedaccountfundverification","metadata":{"seo":{"title":"Simulate Control Check via Test Funding Transaction","description":"Simulate Control Check via Test Funding Transaction"}},"httpPath":"/simulate/v1/linked_accounts/{linked_account_id}/fund"},{"label":"Simulate Buyer KYB Verify","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/simulator/verifybuyerkyb","routeSlug":"/products/payment-run/openapi/simulator/verifybuyerkyb","metadata":{"seo":{"title":"Simulate Buyer KYB Verify","description":"Simulates due diligence (KYB) for Buyers."}},"httpPath":"/simulate/v1/buyers/{buyer_id}/verify"},{"label":"Simulate AIS consent status change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/simulator/postsimulateconsentstatuschange","routeSlug":"/products/payment-run/openapi/simulator/postsimulateconsentstatuschange","metadata":{"seo":{"title":"Simulate AIS consent status change","description":"Simulate AIS consent status change."}},"httpPath":"/simulate/v1/consents/{linked_account_id}/change_status"},{"label":"Simulate issuing a Payment Run SCA Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/simulator/issuepaymentrunchallengesimulate","routeSlug":"/products/payment-run/openapi/simulator/issuepaymentrunchallengesimulate","metadata":{"seo":{"title":"Simulate issuing a Payment Run SCA Challenge","description":"Simulates issuing the SCA challenge for a payment run."}},"httpPath":"/simulate/v1/payment_run_sca/{payment_run_id}/challenges/otp/{channel}"},{"label":"Simulate verifying a payment run SCA Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payment-run/openapi/simulator/verifypaymentrunchallengesimulate","routeSlug":"/products/payment-run/openapi/simulator/verifypaymentrunchallengesimulate","metadata":{"seo":{"title":"Simulate verifying a payment run SCA Challenge","description":"Simulates verifying the SCA challenge for a payment run."}},"httpPath":"/simulate/v1/payment_run_sca/{payment_run_id}/challenges/otp/{channel}/verify"}]},{"type":"separator","label":"Events"},{"type":"group","label":"Buyers","link":"/products/payment-run/openapi/buyers-webhooks","routeSlug":"/products/payment-run/openapi/buyers-webhooks","items":[{"label":"Buyer KYB status update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/buyers-webhooks/webhook_buyer_kyb_watch","routeSlug":"/products/payment-run/openapi/buyers-webhooks/webhook_buyer_kyb_watch","metadata":{"seo":{"title":"Buyer KYB status update","description":"Notification that the KYB status of a buyer identity has been updated."}},"httpPath":"buyerKYBWatch"},{"label":"Buyer Beneficiary status update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/buyers-webhooks/webhook_buyer_beneficiary_kyb_watch","routeSlug":"/products/payment-run/openapi/buyers-webhooks/webhook_buyer_beneficiary_kyb_watch","metadata":{"seo":{"title":"Buyer Beneficiary status update","description":"Notification that the verification status of a buyer beneficiary has been updated."}},"httpPath":"buyerBeneficiaryStatusWatch"},{"label":"Buyer update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/buyers-webhooks/webhook_buyer_watch","routeSlug":"/products/payment-run/openapi/buyers-webhooks/webhook_buyer_watch","metadata":{"seo":{"title":"Buyer update","description":"Notification that a buyer has been updated."}},"httpPath":"buyerWatch"},{"label":"Buyer deactivation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/buyers-webhooks/webhook_buyer_deactivated_watch","routeSlug":"/products/payment-run/openapi/buyers-webhooks/webhook_buyer_deactivated_watch","metadata":{"seo":{"title":"Buyer deactivation","description":"Notification that a buyer identity has been deactivated."}},"httpPath":"buyerDeactivatedWatch"}]},{"type":"group","label":"Payment runs","link":"/products/payment-run/openapi/payment-runs-webhooks","routeSlug":"/products/payment-run/openapi/payment-runs-webhooks","items":[{"label":"Payment Run Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/payment-runs-webhooks/webhookpaymentrunwatch","routeSlug":"/products/payment-run/openapi/payment-runs-webhooks/webhookpaymentrunwatch","metadata":{"seo":{"title":"Payment Run Update","description":"Notification that the status of a Payment Run has been updated."}},"httpPath":"paymentRunWatch"},{"label":"Payment Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/payment-runs-webhooks/webhookpaymentrunpaymentwatch","routeSlug":"/products/payment-run/openapi/payment-runs-webhooks/webhookpaymentrunpaymentwatch","metadata":{"seo":{"title":"Payment Update","description":"Notification that the status of a payment in the Payment Run has been updated."}},"httpPath":"paymentRunPaymentWatch"},{"label":"Payment Run Group Not Funded","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/payment-runs-webhooks/webhookpaymentrungroupnotfunded","routeSlug":"/products/payment-run/openapi/payment-runs-webhooks/webhookpaymentrungroupnotfunded","metadata":{"seo":{"title":"Payment Run Group Not Funded","description":"Notification that a group expecting funds has not been funded."}},"httpPath":"paymentRunGroupNotFunded"}]},{"type":"group","label":"Linked Accounts","link":"/products/payment-run/openapi/linked-accounts-webhooks","routeSlug":"/products/payment-run/openapi/linked-accounts-webhooks","items":[{"label":"Linked Account Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/linked-accounts-webhooks/webhooklinkedaccountwatch","routeSlug":"/products/payment-run/openapi/linked-accounts-webhooks/webhooklinkedaccountwatch","metadata":{"seo":{"title":"Linked Account Update","description":"Notification of the status update for a linked Account."}},"httpPath":"linkedAccountWatch"},{"label":"Linked Account Expiring Soon","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/linked-accounts-webhooks/linkedaccountexpiringsoonwatch","routeSlug":"/products/payment-run/openapi/linked-accounts-webhooks/linkedaccountexpiringsoonwatch","metadata":{"seo":{"title":"Linked Account Expiring Soon","description":"Notification when a linked account is expiring soon."}},"httpPath":"linkedAccountExpiringSoonWatch"}]},{"type":"group","label":"Login","link":"/products/payment-run/openapi/tokens-webhooks","routeSlug":"/products/payment-run/openapi/tokens-webhooks","items":[{"label":"Login attempt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/tokens-webhooks/webhook-login-watch","routeSlug":"/products/payment-run/openapi/tokens-webhooks/webhook-login-watch","metadata":{"seo":{"title":"Login attempt","description":"Notification that a login attempt was completed successfully or declined."}},"httpPath":"loginWatch"}]},{"type":"group","label":"Stepup","link":"/products/payment-run/openapi/stepup-webhooks","routeSlug":"/products/payment-run/openapi/stepup-webhooks","items":[{"label":"Step-up status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/stepup-webhooks/stepup_watch","routeSlug":"/products/payment-run/openapi/stepup-webhooks/stepup_watch","metadata":{"seo":{"title":"Step-up status","description":"Notification that a step-up has been completed or declined."}},"httpPath":"stepupWatch"}]},{"type":"group","label":"Authentication Factors","link":"/products/payment-run/openapi/authentication-factors-webhooks","routeSlug":"/products/payment-run/openapi/authentication-factors-webhooks","items":[{"label":"Enrolment status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/authentication-factors-webhooks/authentication_factors_watch","routeSlug":"/products/payment-run/openapi/authentication-factors-webhooks/authentication_factors_watch","metadata":{"seo":{"title":"Enrolment status","description":"Notification that an enrolment has been accepted or declined."}},"httpPath":"authenticationFactorsWatch"}]},{"type":"group","label":"Transactions","link":"/products/payment-run/openapi/transactions-webhooks","routeSlug":"/products/payment-run/openapi/transactions-webhooks","items":[{"label":"Sweeping status update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/payment-run/openapi/transactions-webhooks/sweeping_watch","routeSlug":"/products/payment-run/openapi/transactions-webhooks/sweeping_watch","metadata":{"seo":{"title":"Sweeping status update","description":"Notification that the sweeping status has been updated."}},"httpPath":"sweepingWatch"}]}]}