Responses

Weavr API

All operations

Reference

Jump to responses

Error

Body

application/json

A machine-readable error code and a human-readable explanation of the failure.

{}

ErrorError · object · 2 fields

BadRequestError

The request is malformed or fails field validation. Correct the request before retrying.

Headers

Body

application/json

{}

objectobject · 2 fields

{
  "message": "One or more request fields are invalid.",
  "syntaxErrors": {
    "invalidFields": [
      {
        "fieldName": "destinationAmount.amount",
        "error": "RANGE",
        "params": [
          "1",
          "100000000"
        ]
      }
    ]
  }
}

Unauthorized

Authentication failed because a required credential is missing, invalid, or expired. Obtain a valid credential before retrying.

Headers

NotFoundToken

Not found - The requested token couldn't be found.

Headers

Body

application/json

The used token is expired or not found

{}

TokenErrorTokenError · object · 1 field

TokenExpired

Gone - The requested token is expired.

Headers

Body

application/json

The used token is expired or not found

{}

TokenErrorTokenError · object · 1 field

Locked

Locked - Account is temporarily locked due to failed consecutive login attempts. Try again in 30 minutes.

Headers

TooManyRequests

The caller has exceeded an API rate limit. Wait until the limit resets before retrying.

Headers

InternalServerError

The request failed because of an unexpected server error. Retrying may succeed; use the request-ref when contacting support.

Headers

ServiceUnavailable

The service is temporarily unavailable. Retry later; use the request-ref when contacting support.

Headers

NoContent

Success - No Content.

Headers

Forbidden

Authentication succeeded, but the caller does not have permission to perform this operation.

Headers

Body

application/json

{}

objectobject · 1 field

{
  "errorCode": "INSUFFICIENT_PERMISSIONS"
}

MethodNotAllowed

Method Not Allowed - The request was received but has been rejected for the requested resource.

Headers

Body

application/json

A machine-readable error code and a human-readable explanation of the failure.

{}

ErrorError · object · 2 fields

StepUpSCAChallengeConflict

Conflict

Body

application/json

{}

objectobject · 1 field

StepUpSCAVerifyConflict

Conflict

Body

application/json

{}

objectobject · 1 field

StepUpSCAChallengePushResponse

Success

Headers

Body

application/json

{}

objectobject · 1 field

StepUpSCAChallengePushConflict

Conflict

Body

application/json

{}

objectobject · 1 field

LogoutResponse

Success

Headers

Body

application/json

{}

objectobject · 1 field

PasswordResponse

Success

Headers

Body

application/json

{}

objectobject · 2 fields

CreatePasswordConflict

Conflict

Body

application/json

{}

objectobject · 1 field

PasswordUpdateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

PasswordValidateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

NotFound

No resource matching the supplied identifier exists or is visible to the caller.

Headers

Body

application/json

A machine-readable error code and a human-readable explanation of the failure.

{}

ErrorError · object · 2 fields

{
  "code": "NOT_FOUND",
  "message": "The requested resource could not be found."
}

LostPasswordInitiateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

TokenResponse

Success

Headers

Body

application/json

{}

TokenResponseTokenResponse · object · 1 field

LostPasswordResumeConflict

Conflict

Body

application/json

{}

objectobject · 1 field

AuthFactorsGetResponse

Success

Headers

Body

application/json

{}

objectobject · 1 field

EnrolDeviceUsingOtpStepOneConflict

Conflict

Body

application/json

{}

objectobject · 1 field

EnrolDeviceUsingOtpStepTwoConflict

Conflict

Body

application/json

{}

objectobject · 1 field

InstrumentForbidden

Forbidden - Access to the requested resource or action is forbidden.

Body

application/json

{}

objectobject · 1 field

EnrolDeviceUsingPushConflict

Conflict

Body

application/json

{}

objectobject · 1 field

UnlinkDeviceUsingPushConflict

Conflict

Body

application/json

{}

objectobject · 1 field

SCAChallengeResponse

Success

Headers

Body

application/json

{}

objectobject · 1 field

MultipleSCAChallengeConflict

Conflict

Body

application/json

{}

objectobject · 1 field

MultipleSCAVerifyConflict

Conflict

Body

application/json

{}

objectobject · 1 field

MultipleSCAChallengePushConflict

Conflict

Body

application/json

{}

objectobject · 1 field

AccessTokenResponse

Success

Headers

Body

application/json

{}

objectobject · 4 fields

UsersGetResponse

Success

Headers

Body

application/json

{}

objectobject · 3 fields

UserResponse

Success

Headers

Body

application/json

{}

UserUser · object · 13 fields

UserForbidden

Forbidden - Access to the requested resource or action is forbidden.

Headers

Body

application/json

{}

objectobject · 1 field

UserCreateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

BulkProcessorConflictResponse

BulkProcessorConflict - bulk processor conflict.

Headers

Body

application/json

{}

BulkProcessConflictBulkProcessConflict · object · 1 field

BulkProcessDetails

Success

Headers

Body

application/json

{}

BulkProcessDetailsBulkProcessDetails · object · 8 fields

BulkProcessOperations

Success

Headers

Body

application/json

{}

BulkProcessOperationsPagedBulkProcessOperationsPaged · object · 3 fields

BulkProcessResponse

Success

Headers

Body

application/json

{}

SubmitBulkProcessResponseSubmitBulkProcessResponse · object · 3 fields

UserPatchConflict

Conflict

Body

application/json

{}

objectobject · 1 field

UserIdentitiesGetResponse

Success

Headers

Body

application/json

{}

UserIdentitiesGetResponseSchemaUserIdentitiesGetResponseSchema · object · 3 fields

UserIdentitiesConflict

Conflict

Body

application/json

{}

objectobject · 1 field

UserInviteSendConflict

Conflict

Body

application/json

{}

objectobject · 1 field

UserInviteValidateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

UserInviteConsumeConflict

Conflict

Body

application/json

{}

objectobject · 1 field

CorporateResponse

Success

Headers

Body

application/json

{}

CorporateCorporate · object · 14 fields

CreateCorporateResponse

Success

Headers

Body

application/json

{}

CreatedCorporateCreatedCorporate · object · 14 fields

CorporateCreateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

CorporateUpdateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

EmailVerificationConflict

Conflict

Body

application/json

{}

objectobject · 1 field

VerifyConflict

Conflict

Body

application/json

{}

objectobject · 1 field

CorporateKybGetResponse

Success

Headers

Body

application/json

{}

objectobject · 2 fields

ChargeFeeResponse

Success

Headers

Body

application/json

{}

ChargeFeeChargeFee · object · 7 fields

ChargeFeeConflict

Conflict

Body

application/json

{}

objectobject · 1 field

FeeTransactionListResponse

Success

Headers

Body

application/json

A paginated list of fee transactions.

{}

FeeTransactionListFeeTransactionList · object · 3 fields

ConsumerResponse

Success

Headers

Body

application/json

{}

ConsumerConsumer · object · 11 fields

ConsumerCreateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ConsumerUpdateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ConsumerKycGetResponse

Success

Headers

Body

application/json

{}

objectobject · 4 fields

ConsumerKycStartResponse

Success

Headers

Body

application/json

{}

objectobject · 2 fields

ConsumerKycStartConflict

Conflict

Body

application/json

{}

objectobject · 1 field

LinkedAccountsGetResponse

Success

Headers

Body

application/json

{}

objectobject · 3 fields

LinkedAccountResponse

Success

Headers

Body

application/json

{}

LinkedAccountLinkedAccount · object · 12 fields

LinkedAccountRegisterConflict

Conflict

Body

application/json

{}

objectobject · 1 field

LinkedAccountRemoveConflict

Conflict

Body

application/json

{}

objectobject · 1 field

LinkedAccountBlockConflict

Conflict

Body

application/json

{}

objectobject · 1 field

LinkedAccountUnblockConflict

Conflict

Body

application/json

{}

objectobject · 1 field

LinkedAccountVerificationRunsGetResponse

Success

Headers

Body

application/json

{}

objectobject · 3 fields

ManagedAccountsGetResponse

Success

Headers

Body

application/json

{}

objectobject · 3 fields

ManagedAccountResponse

Success

Headers

Body

application/json

{}

ManagedAccountManagedAccount · object · 9 fields

ManagedAccountCreateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedAccountIBANResponse

Success

Headers

Body

application/json

{}

ManagedAccountIBANManagedAccountIBAN · object · 2 fields

ManagedAccountsIBANUpgradeConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedAccountBlockConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedAccountUnblockConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedAccountStatementResponse

Success

Headers

Body

application/json

The list of statement entries.

{}

StatementStatement · object · 6 fields

Body

application/pdf

string · binary

Body

text/csv

{}

StatementEntryStatementEntry · object · 16 fields

InstrumentStatementJsonResponse

Success

Headers

Body

application/json

A financial statement for an instrument over a given period. Contains only posted/completed transactions where funds have definitively moved (actual balance changed). Repeated requests for the same period return the same result.

{}

StatementResponseStatementResponse · object · 6 fields

Body

application/pdf

string · binary

InstrumentTransactionActivityListResponse

Success

Headers

Body

application/json

A paginated list of transaction activity entries scoped to a single instrument.

{}

InstrumentTransactionActivityListInstrumentTransactionActivityList · object · 3 fields

InstrumentTransactionActivityResponse

Success

Headers

Body

application/json

A transaction activity entry returned by the per-instrument transactions endpoints (e.g. /managed_accounts/{id}/transactions). The instrument is omitted because it is already known from the path parameter.

{}

InstrumentTransactionActivityItemInstrumentTransactionActivityItem · object · 9 fields

ManagedAccountRemoveConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedCardPageResponse

Success

Headers

Body

application/json

{}

objectobject · 3 fields

ManagedCardResponse

Success

Headers

Body

application/json

{}

ManagedCardManagedCard · object · 33 fields

ManagedCardConflict

Conflict

Body

application/json

{}

objectobject · 1 field

SystemManagedCardPageResponse

Success

Headers

Body

application/json

{}

objectobject · 3 fields

SystemManagedCardResponse

Success

Headers

Body

application/json

{}

SystemManagedCardSystemManagedCard · object · 25 fields

SystemManagedCardConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedCardUpdateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedCardBlockConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedCardUnblockConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedCardRemoveConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedCardStatementResponse

Success

Headers

Body

application/json

The list of statement entries.

{}

StatementStatement · object · 6 fields

Body

application/pdf

string · binary

Body

text/csv

{}

StatementEntryStatementEntry · object · 16 fields

CardPaymentListResponse

Success

Headers

Body

application/json

Paginated list of CardPayments.

{}

CardPaymentListCardPaymentList · object · 3 fields

CardPaymentResponse

Success

Headers

Body

application/json

One card transaction's full lifecycle — authorisation, settlement, refunds — as a single resource that the platform keeps up to date as scheme events arrive.

Designed for two audiences:

Building UI? Read the top-level summary fields (displayAmount, status, type, merchant, card). They are platform-maintained — show them as-is. No need to understand auth-vs-clearing, reversals, or scheme messages. The debit/credit direction is implicit from type (purchases / cash withdrawals / account funding debit the card; refunds / original credits credit it). For the issuer authorisation code, walk events[] — every event in the lifecycle carries it.
Need scheme-level detail? Walk events[] for the full per-step audit trail — every authorisation, clearing, reversal, and refund step — with original scheme amounts (merchant + card currency, with exchange rates), reason codes, and fees attached to the event that triggered them.

Each card payment corresponds to one card-scheme lifecycle (Visa Transaction Identifier / Mastercard TLID). Related-but-separate transactions (refunds, tips, recurring follow-ups) are separate card payments linked via relatedCardPaymentId (direct parent).

{}

CardPaymentCardPayment · object · 11 fields

CardPaymentEventListResponse

Success

Headers

Body

application/json

Paginated list of CardPaymentEventDetail.

{}

CardPaymentEventListCardPaymentEventList · object · 3 fields

ManagedCardSpendRulesGetResponse

Success

Headers

Body

application/json

{}

AllLevelSpendRulesAllLevelSpendRules · object · 17 fields

ManagedCardSpendRulesCreateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedCardSpendRulesUpdateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedCardGetResponse

Success

Headers

Body

application/json

{}

ManagedCardManagedCard · object · 33 fields

ManagedCardPhysicalUpgradeConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedCardPhysicalActivateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedCardPhysicalPinGetResponse

Success

Headers

Body

application/json

{}

objectobject · 1 field

ManagedCardPhysicalPinGetConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedCardPhysicalPinUnBlockConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedCardPhysicalReplaceDamagedConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedCardPhysicalReportLostConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedCardPhysicalReportStolenConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedCardPhysicalReplaceLostOrStolenConflict

Conflict

Body

application/json

{}

objectobject · 1 field

ManagedCardPhysicalContactlessLimitResetConflict

Conflict

Body

application/json

{}

objectobject · 1 field

TransfersGetResponse

Success

Headers

Body

application/json

{}

objectobject · 3 fields

TransferResponse

Success

Headers

Body

application/json

{}

TransferTransfer · object · 12 fields

TransferConflict

Conflict

Body

application/json

{}

objectobject · 1 field

TransactionBulkCancelResponse

Success

Headers

Body

application/json

{}

TransactionBulkCancelResponseTransactionBulkCancelResponse · object · 1 field

SendsGetPageResponse

Success

Headers

Body

application/json

{}

objectobject · 3 fields

SendResponse

Success

Headers

Body

application/json

{}

SendSend · object · 16 fields

SendCreateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

SendCancelConflict

Conflict

Body

application/json

{}

objectobject · 1 field

SendSCAChallengeConflict

Conflict

Body

application/json

{}

objectobject · 1 field

SendSCAVerifyConflict

Conflict

Body

application/json

{}

objectobject · 1 field

SendSCAChallengePushConflict

Conflict

Body

application/json

{}

objectobject · 1 field

IncomingWireTransferListResponse

Success

Headers

Body

application/json

A paginated list of incoming wire transfers.

{}

IncomingWireTransferListIncomingWireTransferList · object · 3 fields

IncomingWireTransferResponse

Success

Headers

Body

application/json

An incoming wire transfer received from an external bank account.

{}

IncomingWireTransferIncomingWireTransfer · object · 14 fields

OutgoingWireTransfersGetPageResponse

Success

Headers

Body

application/json

{}

objectobject · 3 fields

OutgoingWireTransferResponse

Success

Headers

Body

application/json

{}

OutgoingWireTransferOutgoingWireTransfer · object · 18 fields

OutgoingWireTransferCreateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

OutgoingWireTransferUpdateBeneficiaryNameConflict

Update beneficiary name conflict

Body

application/json

{}

OutgoingWireTransferUpdateBeneficiaryNameConflictOutgoingWireTransferUpdateBeneficiaryNameConflict · object · 1 field

OutgoingWireTransferPaymentConfirmationConflict

The outgoing wire transfer exists but is not in a state for which a payment confirmation can be produced.

Body

application/json

{}

OutgoingWireTransferPaymentConfirmationConflictOutgoingWireTransferPaymentConfirmationConflict · object · 1 field

OutgoingWireTransferCancelConflict

Conflict

Body

application/json

{}

objectobject · 1 field

OutgoingWireTransferConfirmConflict

Conflict

Body

application/json

{}

objectobject · 1 field

OutgoingWireTransferSCAChallengeConflict

Conflict

Body

application/json

{}

objectobject · 1 field

OutgoingWireTransferSCAVerifyConflict

Conflict

Body

application/json

{}

objectobject · 1 field

OutgoingWireTransferSCAChallengePushConflict

Conflict

Body

application/json

{}

objectobject · 1 field

CorrespondentBankingOwtsResponse

Success

Headers

Body

application/json

{}

objectobject · 3 fields

CorrespondentBankingOwtResponse

Success

Headers

Body

application/json

{}

CorrespondentBankingOwtCorrespondentBankingOwt · object · 15 fields

CorrespondentBankingOwtCreateConflict

Conflict

Body

application/json

{}

objectobject · 1 field

CorrespondentBankingOwtCancelConflict

Conflict

Body

application/json

{}

objectobject · 1 field

CorrespondentBankingOwtConfirmConflict

Conflict

Body

application/json

{}

objectobject · 1 field

BeneficiaryPageResponse

Success

Headers

Body

application/json

{}

objectobject · 3 fields

BeneficiaryBatchResponse

Success

Headers

Body

application/json

{}

BeneficiaryBatchBeneficiaryBatch · object · 3 fields

BeneficiaryResponse

Success

Headers

Body

application/json

{}

BeneficiaryBeneficiary · object · 9 fields

BeneficiaryBatchPageResponse

Success

Headers

Body

application/json

{}

objectobject · 3 fields

BeneficiaryBatchSCAChallengeConflict

Conflict

Body

application/json

{}

objectobject · 1 field

BeneficiaryBatchSCAVerifyConflict

Conflict

Body

application/json

{}

objectobject · 1 field

BeneficiaryBatchSCAChallengePushConflict

Conflict

Body

application/json

{}

objectobject · 1 field

TransactionActivityListResponse

Success

Headers

Body

application/json

A paginated list of transaction activity entries.

{}

TransactionActivityListTransactionActivityList · object · 3 fields

Responses

Error

LoginWithPasswordResponse

BadRequestError

Unauthorized

NotFoundToken

LoginWithPasswordConflict

TokenExpired

Locked

TooManyRequests

InternalServerError

ServiceUnavailable

LoginViaBiometricsResponse

LoginViaBiometricsConflict

LoginWithIamResponse

NoContent

Forbidden

MethodNotAllowed

StepUpSCAChallengeConflict

StepUpSCAVerifyConflict

StepUpSCAChallengePushResponse

StepUpSCAChallengePushConflict

LogoutResponse

PasswordResponse

CreatePasswordConflict

PasswordUpdateConflict

PasswordValidateConflict

NotFound

LostPasswordInitiateConflict

TokenResponse

LostPasswordResumeConflict

AuthFactorsGetResponse

EnrolDeviceUsingOtpStepOneConflict

EnrolDeviceUsingOtpStepTwoConflict

InstrumentForbidden

EnrolDeviceUsingPushConflict

UnlinkDeviceUsingPushConflict

SCAChallengeResponse

MultipleSCAChallengeConflict

MultipleSCAVerifyConflict

MultipleSCAChallengePushConflict

AccessTokenResponse

UsersGetResponse

UserResponse

UserForbidden

UserCreateConflict

BulkProcessorConflictResponse

BulkProcessDetails

BulkProcessOperations

BulkProcessResponse

UserPatchConflict

UserIdentitiesGetResponse

UserIdentitiesConflict

UserInviteSendConflict

UserInviteValidateConflict

UserInviteConsumeConflict

CorporateResponse

CreateCorporateResponse

CorporateCreateConflict

CorporateUpdateConflict

EmailVerificationConflict

VerifyConflict

CorporateKybGetResponse

ChargeFeeResponse

ChargeFeeConflict

FeeTransactionListResponse

ConsumerResponse

ConsumerCreateConflict

ConsumerUpdateConflict

ConsumerKycGetResponse

ConsumerKycStartResponse

ConsumerKycStartConflict

LinkedAccountsGetResponse

LinkedAccountResponse

LinkedAccountRegisterConflict

LinkedAccountRemoveConflict

LinkedAccountBlockConflict

LinkedAccountUnblockConflict

LinkedAccountVerificationRunsGetResponse

ManagedAccountsGetResponse