---
title: "Update a payout recipient"
method: PATCH
path: "/payout-recipients/{recipient_id}"
---

# Update a payout recipient

`PATCH /payout-recipients/{recipient_id}`

## Request

- Base URL: `https://api-sandbox.straitsx.com/v1`
- URL: `https://api-sandbox.straitsx.com/v1/payout-recipients/{recipient_id}`
- Auth: none required

## Path parameters

- `recipient_id` string, required

## Headers

- `X-XFERS-APP-API-KEY` string, required
- `X-PUBLIC-KEY-ID` string
- `X-TIMESTAMP` string
- `X-NONCE` string
- `X-SIGNATURE` string

## Request body

- object
  - `data` object
    - `attributes` object
      - `recipientCountry` string: Accepts alpha-2 country code e.g. `SG`
      - `recipientInformation` object
        - `recipientName` string: Name of the recipient
        - `proxyType` 'mobile_number' | 'nric' | 'uen' | 'vpa': Type of PayNow proxy
        - `proxyValue` string: Acceptable value:<br />1. proxyType = `mobile_number`<br />- Format: Start with '+65' followed by a minimum of 8 characters and a maximum of 16 characters.<br />- Example: +6512345678<br /><br />2. proxyType = `nric`<br />- Format: Should consist of 9 characters, accepting both NRIC and FIN Numbers.<br />- Example: S1234567A<br /><br />3. proxyType = `uen`<br />- Alphanumeric characters with a minimum of 9 characters and a maximum of 13 characters.<br />- Example: 201411660R<br /><br />4. proxyType = `vpa`<br />- Format: [Mobile number or UEN number]#[Unique payment identifier (UPI)]<br />- UPI is a unique identifier for institutions participating in PayNow.<br />- Example for mobile number VPA format: +6512345678#GRAB<br />- Example for UEN VPA format: UEN201411660R#FAZZ<br /><br />Note: The proxyType field specifies the type of proxy identifier to be used in PayNow transactions. Ensure that the values provided match the specified formats and guidelines for each 'proxyType' option.
        - `bankAccountNo` string: Recipient's bank account number
        - `bankShortCode` string: Bank account abbreviation (`abbreviation`) can be retrieved from [Get a list of supported banks API](https://docs.straitsx.com/reference/get-a-list-of-supported-banks)
        - `swiftBic` string: SWIFT code of the payout recipient<br>Regex: `/^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$/`<br><br><strong>Note:</strong> Must be uppercase
        - `recipientAddress` object
          - `address` string
          - `city` string
          - `postalCode` string
          - `state` string
          - `country` string
        - `routingCode` string: Routing code if applicable<br>Regex: `/^[A-Z0-9]{1,31}$/`<br><br><strong>Note:</strong> Must be uppercase
        - `intermediarySwiftBic` string: Intermediary SWIFT code if applicable<br>Regex: `/^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$/`<br><br><strong>Note:</strong> Must be uppercase
        - `paymentReason` string: Payment reason is a field used to pass clear, specific instructions to the receiving bank.<br />Length: 1 - 150 characters (Non-blank)<br />Regex: `/^\s*.{1,150}\s*$/`<br /><br />Note: This value will override the default Remittance Information (MT103 Field 70 / pacs.008) in the final payment message sent to the bank when provided.

## Response `200`

200

- union
  - object
    - `data` object
      - `id` string: Payout recipient ID.
      - `type` string: Request type.
      - `attributes` object
        - `recipientCountry` string: The country where the recipient is located.
        - `recipientInformation` object: Recipient information.
          - `entityType` string: Recipient entity type.
          - `currency` string: Currency for the transfer.
          - `disbursementMethod` string: Disbursement method used to send funds.
          - `recipientName` string: Name of the recipient.
          - `bankAccountNo` string: Recipient's bank account number.
          - `bankShortCode` string: Recipient's bank short code.
        - `createdAt` string: Timestamp when the payout recipient was created.
        - `updatedAt` string: Timestamp when the payout recipient was last updated.
  - object
    - `data` object
      - `id` string: Payout recipient ID.
      - `type` string: Request type.
      - `attributes` object
        - `recipientCountry` string: The country where the recipient is located.
        - `recipientInformation` object: Recipient information.
          - `entityType` string: Recipient entity type.
          - `currency` string: Currency for the transfer.
          - `disbursementMethod` string: Disbursement method used to send funds.
          - `recipientName` string: Name of the recipient.
          - `proxyType` string: Type of PayNow proxy.
          - `proxyValue` string: The actual PayNow identifier value.
        - `createdAt` string: Timestamp when the payout recipient was created.
        - `updatedAt` string: Timestamp when the payout recipient was last updated.
  - object
    - `data` object
      - `id` string: Payout recipient ID.
      - `type` string: Request type.
      - `attributes` object
        - `recipientCountry` string: The country where the recipient is located.
        - `recipientInformation` object: Recipient information.
          - `entityType` string: Recipient entity type.
          - `currency` string: Currency for the transfer.
          - `disbursementMethod` string: Disbursement method used to send funds.
          - `recipientName` string: Name of the recipient.
          - `bankAccountNo` string: Recipient's bank account number.
          - `swiftBic` string: SWIFT code of the payout recipient.
          - `recipientAddress` object: Recipient address details.
            - `address` string: Street address.
            - `city` string: City name.
            - `postalCode` string: Postal or ZIP code.
            - `state` string: State or region.
            - `country` string: Country code.
          - `routingCode` string: Routing code.
          - `intermediarySwiftBic` string: Intermediary SWIFT code.
          - `paymentReason` string: Payment reason is a field used to pass clear, specific instructions to the receiving bank.
        - `createdAt` string: Timestamp when the payout recipient was created.
        - `updatedAt` string: Timestamp when the payout recipient was last updated.

---

[API](https://skmtc.dev/straitsx/apis/base-url.md) - [All operations](https://skmtc.dev/straitsx/apis/base-url/llms.txt) - [OpenAPI document](https://skmtc.dev/straitsx/apis/base-url/revisions/a016bf48febc?raw)