Recipient Flows

Creating a recipient

The recipient is a person or institution who is the ultimate beneficiary of a transfer. Requirements for Recipient will vary depending on their type.

The 3.2. [EntryPoint] Create the recipient for the quote process handles this flow.

Process payload

{
     "recipientBody": {
          "currency": "GBP",
          "type": "sort_code",
          "profile": 14733,
          "ownedByCustomer": true,
          "accountHolderName": "Ann Johnson",
          "details": {
                    "email": "ana_Jhons@mail.com",
                    "legalType": "PRIVATE",
                    "sortCode": "231470",
                    "accountNumber": "28821822"
          }
     },
     "token": "e0172d1b-e17f-40d2-94af-784fc59da298",
     "language": "es"
}

Get the recipients list

Each user has their own list of recipients associated with their Wise profile. This process retrieves the list of all recipients filtered by profileId.

The 3.2.1. [EntryPoint] Get recipient list process handles this flow.

Process payload

{
     "profileId": 14733,
     "token": "e0581691-4e43-474f-88c9-f2583027608b"
}

Get recipient account info by ID

The response to this flow includes a hash of a recipient, which can be used to track if the recipient details changes. The hash will remain constant unless the recipient’s name or the information in the details object changes.

The 3.2.2. [EntryPoint] Get recipient account info by id - v2 process handles this flow.

Process payload

{
  "accountId": "148165674",
   "token": "e0581691-4e43-474f-88c9-f2583027608b"
}

Deleting a recipient

A recipient can be deleted by changing their status to inactive. Only active recipients can be deleted and a recipient cannot be reactivated; however, a new recipient can be created with the same details.

The 3.2.6. [EntryPoint] Delete recipient process handles this flow.

Process payload

{
   "accountId": "148165674",
   "token": "e0581691-4e43-474f-88c9-f2583027608b"
}

Creating a refund recipient

A refund recipient is a person or institution that will receive a refund transfer from Wise. The process payload for creating refund recipients will differ depending on the source currency.

The 3.2.4 [EntryPoint] Create refund recipient - v2 process handles this flow.

Process payload

{
     "refundRecipientBody": {
          "currency": "GBP",
          "country": "GB",
          "type": "sort_code",
          "profile": 14733,
          "legalEntityType": "PERSON",
          "name": {
                    "fullName": "Ann Johnson"
          },
          "details": {
               "sortCode": "231470",
               "accountNumber": "28821822"
          }
     },
     "token": "e0581691-4e43-474f-88c9-f2583027608b"
}

Get the receipt PDF

This process allows you to download the transfer confirmation receipt, in PDF format, for transfers that are have the outgoing_payment_sent status.

The 3.2.5. [EntryPoint] Get Receipt PDF - v1 process handles this flow.

Process payload

{
     "transferId": "49511866",
     "token": "e0581691-4e43-474f-88c9-f2583027608b"
}

Patching quotes with recipient information

All quotes should be updated with the recipient data to retrieve the correct payment options, prices, and the estimated delivery time. This is due to the different costs charged by different payment networks that may be used by Wise to send currencies to some countries. For more information, see the quotes update endpoint in the Wise documentation.

The 3.3. [EntryPoint] Patch Quote with recipient information process handles this flow.

Process payload

{
     "profileId": 14733,
     "quoteId": "e2451439-ff94-4146-9ff4-b6e1d65bb3cb",
     "recipientId": 147774783,
     "token": "e0581691-4e43-474f-88c9-f2583027608b"
}