Endpoints now supporting idempotency

We are introducing idempotencyIdempotency A property of an API that guarantees calling it multiple times with the same inputs produces the same result, with no additional side effects beyond the first call. An idempotent endpoint can therefore be safely retried after network errors or timeouts without risking duplicate transactions or state changes. to a list of endpoints in the plug-in API. This is can be achieved by including the idempotency-ref header in the requests.

Effective:

• 12 August 2024 on Sandbox
• 20 August 2024 on Live

Using IdempotencyIdempotency A property of an API that guarantees calling it multiple times with the same inputs produces the same result, with no additional side effects beyond the first call. An idempotent endpoint can therefore be safely retried after network errors or timeouts without risking duplicate transactions or state changes. is optional. However, if you decide to use it, you need handle the new HTTP 409 error code IDEMPOTENT_REQUEST_IN_PROGRESS. Additionally, if an idempotent endpoint is called with an idempotency-ref header exceeding 8000 characters, an HTTP 413 Payload Too Large error should be returned. If an idempotent endpoint is called twice with the same idempotency-ref but with different payloads, an HTTP 422 Unprocessable Entity error should be returned.

Affected endpoints with idempotencyIdempotency A property of an API that guarantees calling it multiple times with the same inputs produces the same result, with no additional side effects beyond the first call. An idempotent endpoint can therefore be safely retried after network errors or timeouts without risking duplicate transactions or state changes.:

• Step up
  • POST/stepup/challenges/otp/{channel}
  • POST/stepup/challenges/otp/{channel}/verify
• BuyersBuyer A business entity in the Payment Run solution that can be provided with financial services to perform embedded payment runs. Buyers are onboarded through a KYB process and can create payment runs to pay their suppliers. They have roles such as Admin, Controller, and Creator.
  • POST/buyers
  • POST/buyers/verification/email/send
  • POST/buyers/verification/email/verify
  • POST/buyers/kyb
• BuyerBuyer A business entity in the Payment Run solution that can be provided with financial services to perform embedded payment runs. Buyers are onboarded through a KYB process and can create payment runs to pay their suppliers. They have roles such as Admin, Controller, and Creator. authorized usersAuthorized User An individual that has been invited by the root user to manage an identity's instruments and transactions. They are not the legal owner of the identity but can be granted access to perform operations on behalf of the identity. For corporates, card assignees are created as Authorized Users. US-English variant of _Authorised User_.
  • POST/users
  • POST/users/{user_id}/activate
  • POST/users/{user_id}/deactivate
  • POST/users/{user_id}/invite
  • POST/users/{user_id}/invite/validate
  • POST/users/{user_id}/invite/consume
  • POST/users/verification/email/send
  • POST/users/verification/email/verify
• Payment RunsPayment Run A list of payments created by Buyers to settle their outstanding financial obligations with their suppliers. Payment runs are typically managed by the accounts payable function within a business on a periodic basis and go through stages of creation, authorisation, funding, and execution.
  • POST/payment_runs
  • POST/payment_runs/{payment_run_id}/confirm
  • POST/payment_runs/{payment_run_id}/cancel
• Linked AccountsLinked Account An entity in the Weavr system that represents an external bank account or payment service provider (PSP) account which an Identity has verified they own and control. This feature enables users to perform transactions, such as outgoing and incoming wire transfers, between their Linked Accounts and their Managed Accounts as 'self-to-self' transfers.
  • POST/linked_accounts/{linked_account_id}/unlink

You can find more information about idempotency in our docs.