Skip to content
/
Simulate Creating a Linke...

Simulate Creating a Linked Account via Open Banking

Request

The Linked Account Simulator allows you to create a simulated linked account that can be used for funding payment runs.

This endpoint will only function in Sandbox and should not be used in the Live environment.

Security
apiKey
Bodyapplication/jsonrequired
buyerIdstringrequired
accountIdentificationFasterPaymentsBankDetails (object) or SepaBankDetails (object)required
One of:

Bank details used in case the wire transfer is executed over Faster Payments.

institutionIdstringdeprecated
createdBystringdeprecated
currencystring, = 3 charactersdeprecated

The currency expressed in ISO-4217 code.

Default:"GBP"
Enum:"GBP""EUR"
curl -i -X POST \
  https://sandbox.weavr.io/payment-run/simulate/v1/linked_accounts \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "institutionId": "string",
    "buyerId": "string",
    "createdBy": "string",
    "accountIdentification": {
      "accountNumber": "stringst",
      "sortCode": "string",
      "secondaryReference": "string"
    },
    "currency": "GBP"
  }'

Responses

OK

Bodyapplication/json
idstring^[0-9a-fA-F]{24}$required

The unique identifier of the linked account

Example:"652d25b73541d8084a88a38d"
accountIdentificationFasterPaymentsBankDetails (object) or SepaBankDetails (object)required
One of:

Bank details used in case the wire transfer is executed over Faster Payments.

currencystring, = 3 charactersrequired

The primary currency associated with the account

Enum:"GBP""EUR"
institutionobjectrequired
consentobjectrequired
statusstringrequired

The status of the linked account. The status can be one of the following:

  • PENDING_CHALLENGE: The Linked Account is pending challenge
  • PENDING_VERIFICATION: The Linked Account is pending the completion of the required verification steps
  • PENDING_FUNDING: Awaiting a wire transfer as part of the verification process when adding an account without Open Banking
  • REJECTED: The Linked Account did not pass one or more verification steps and is not eligible for use
  • LINKED: The linked account is linked and ready for use
  • UNLINKED: The linked account is not linked and cannot be used
Enum:"LINKED""UNLINKED""PENDING_CHALLENGE""PENDING_FUNDING""PENDING_VERIFICATION""REJECTED"
friendlyNamestring, <= 80 characters

A user-friendly name for the linked account

createdAtstring
Response
{
  "id": "652d25b73541d8084a88a38d",
  "accountIdentification": {
    "accountNumber": "stringst",
    "sortCode": "string",
    "secondaryReference": "string"
  },
  "currency": "GBP",
  "institution": {
    "displayName": "string",
    "countries": [ … ],
    "images": { … },
    "info": { … }
  },
  "consent": {
    "expiresAt": "2019-08-24T14:15:22Z",
    "expiresIn": 0,
    "status": "ACTIVE"
  },
  "status": "LINKED",
  "friendlyName": "string",
  "createdAt": "string"
}