Recipient

A recipient account: create, list, get or deactivate one.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

recipients, err := client.Recipient(nil).List(nil, nil)
if err != nil {
    panic(err)
}
fmt.Println(recipients)
recipient, err := client.Recipient(nil).Load(map[string]any{"account_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(recipient)
created, err := client.Recipient(nil).Create(map[string]any{"acceptedOutcomes": true, "ultimateBeneficiary": map[string]any{}}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)
updated, err := client.Recipient(nil).Update(map[string]any{"account_id": 1, "quote_id": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(updated)
removed, err := client.Recipient(nil).Remove(map[string]any{"account_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(removed)

Lua

Construct client as shown in the Lua setup, then call the operations:

local recipients, err = client:Recipient():list()
local recipient, err = client:Recipient():load({ account_id = 1 })
local created, err = client:Recipient():create({ acceptedOutcomes = true, ultimateBeneficiary = {} })
local updated, err = client:Recipient():update({ account_id = 1, quote_id = "example" })
local removed, err = client:Recipient():remove({ account_id = 1 })

PHP

Construct client as shown in the PHP setup, then call the operations:

$recipients = $client->Recipient()->list();
$recipient = $client->Recipient()->load(["account_id" => 1]);
$created = $client->Recipient()->create(["acceptedOutcomes" => true, "ultimateBeneficiary" => []]);
$updated = $client->Recipient()->update(["account_id" => 1, "quote_id" => "example"]);
$client->Recipient()->remove(["account_id" => 1]);

Python

Construct client as shown in the Python setup, then call the operations:

recipients = client.Recipient().list()
recipient = client.Recipient().load({"account_id": 1})
created = client.Recipient().create({ "acceptedOutcomes": True, "ultimateBeneficiary": {} })
updated = client.Recipient().update({"account_id": 1, "quote_id": "example"})
client.Recipient().remove({"account_id": 1})

Ruby

Construct client as shown in the Ruby setup, then call the operations:

recipients = client.Recipient.list()
recipient = client.Recipient.load({ "account_id" => 1 })
created = client.Recipient.create({ "acceptedOutcomes" => true, "ultimateBeneficiary" => {} })
updated = client.Recipient.update({ "account_id" => 1, "quote_id" => "example" })
client.Recipient.remove({ "account_id" => 1 })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const recipients = await client.Recipient().list()
const recipient = await client.Recipient().load({ account_id: 1 })
const created = await client.Recipient().create({ acceptedOutcomes: true, ultimateBeneficiary: {} })
const updated = await client.Recipient().update({ account_id: 1, quote_id: "example" })
await client.Recipient().remove({ account_id: 1 })

Fields

create

POST /accounts/{accountId}/quotes/{quoteId}/compatibility

Operation ID: recipientCompatibilityCheck.

Authentication: bearer token (UserToken).

Parameters

Responses

200: Returns the compatibility result, including any verification outcomes. See the Recipient verification guide for details about handling the confirmations object

application/json

Example response:

{
  "accountId": 40000000,
  "confirmations": {
    "acceptedAt": null,
    "acceptedOutcomes": false,
    "outcomes": [
      {
        "fieldsChecked": [
          "name/fullName",
          "details/accountNumber"
        ],
        "message": "The name entered is slightly different to the name on the account.",
        "outcome": "PARTIAL_FAILURE",
        "providedName": "John Doe",
        "recommendedUpdates": [
          {
            "path": "name/fullName",
            "value": "Joe Doe"
          }
        ],
        "requiresCustomerAcceptance": true,
        "resolvedName": "Joe Doe",
        "type": "NAME_MATCHING"
      }
    ],
    "quoteId": "00000000-0000-0000-0000-000000000000"
  },
  "quoteId": "00000000-0000-0000-0000-000000000000"
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

POST /accounts

Operation ID: recipientCreate.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Responses

200: Recipient account created successfully

application/json

400: Bad Request, validation error

application/json

401: Unauthorized

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

list

GET /accounts

Operation ID: recipientList.

Authentication: bearer token (UserToken).

Parameters

Responses

200: Paginated list of recipient accounts

application/json

Example response:

{
  "content": [
    {
      "accountSummary": "(04-00-75) 37778842",
      "active": true,
      "commonFieldMap": {
        "accountNumberField": "accountNumber",
        "bankCodeField": "sortCode"
      },
      "country": "GB",
      "creatorId": 41000000,
      "currency": "GBP",
      "details": {
        "accountNumber": "37778842",
        "hashedByLooseHashAlgorithm": "ad245621b974efa3ef870895c3wer419a3f01af18a8a5790b47645dba6304194",
        "reference": null,
        "sortCode": "040075"
      },
      "displayFields": [
        {
          "key": "details/sortCode",
          "label": "UK sort code",
          "value": "04-00-75"
        },
        {
          "key": "details/accountNumber",
          "label": "Account number",
          "value": "37778842"
        }
      ],
      "hash": "666ef880f8aa6113fa112ba6531d3ed2c26dd9fgbd7de5136bfb827a6e800479",
      "id": 40000000,
      "isInternal": false,
      "legalEntityType": "PERSON",
      "longAccountSummary": "GBP account ending in 8842",
      "name": {
        "cannotHavePatronymicName": null,
        "familyName": null,
        "fullName": "John Doe",
        "givenName": null,
        "middleName": null,
        "patronymicName": null
      },
      "ownedByCustomer": false,
      "profileId": 30000000,
      "type": "SortCode"
    }
  ],
  "seekPositionForCurrent": 40000000,
  "seekPositionForNext": 40000001,
  "size": 20,
  "sort": {
    "empty": true,
    "sorted": false,
    "unsorted": true
  }
}

401: Unauthorized

403: Forbidden

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

load

GET /accounts/{accountId}

Operation ID: recipientGet.

Authentication: bearer token (UserToken).

Parameters

Responses

200: Recipient account details

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

remove

DELETE /accounts/{accountId}

Operation ID: recipientDeactivate.

Authentication: bearer token (UserToken).

Parameters

Responses

200: Recipient returned with active=false

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

update

PATCH /accounts/{accountId}/confirmations

Operation ID: recipientConfirmationsAccept.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Responses

200: Recipient with updated confirmation status

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.