Third-Party Recipients

Tell Harbor whether a transfer goes to the Customer or to someone else, with is_self_transfer.

Every transfer has a sender, the Customer in on_behalf_of, and a recipient (beneficiary), described in destination. Use destination.is_self_transfer to tell Harbor whether they are the same person or business:

  • true: the Customer is sending funds to themselves, such as to their own bank account or wallet.
  • false: the Customer is paying someone else, a third party.

Harbor uses this value for compliance checks and transaction records. On transfers that send stablecoins to a wallet, it's also part of the Travel Rule information.

⚠️

Set it correctly
If is_self_transfer doesn't match the actual sender and recipient, the transfer may be delayed or cancelled.

Send to the Customer

Set is_self_transfer to true, and use the Customer's own details as the beneficiary.

curl --location --request POST 'https://harbor-sandbox.owlpay.com/api/v2/transfers' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-API-KEY: {{API_KEY}}' \
--header 'X-Idempotency-Key: {{Idempotency-Key}}' \
--data-raw '{
    "quote_id": "{{QUOTE_ID}}",
    "on_behalf_of": "{{CUSTOMER_UUID}}",
    "application_transfer_uuid": "{{APPLICATION_TRANSFER_UUID}}",
    "destination": {
        "beneficiary_info": {
            "beneficiary_name": "{{CUSTOMER_NAME}}",
            ...
        },
        "transfer_purpose": "TRANSFER_TO_OWN_ACCOUNT",
        "is_self_transfer": true,
        ...
    }
}'

Send to a Third Party

Set is_self_transfer to false, and use the third party's details as the beneficiary. In this example, the Customer pays Sam Rivera.

curl --location --request POST 'https://harbor-sandbox.owlpay.com/api/v2/transfers' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-API-KEY: {{API_KEY}}' \
--header 'X-Idempotency-Key: {{Idempotency-Key}}' \
--data-raw '{
    "quote_id": "{{QUOTE_ID}}",
    "on_behalf_of": "{{CUSTOMER_UUID}}",
    "application_transfer_uuid": "{{APPLICATION_TRANSFER_UUID}}",
    "destination": {
        "beneficiary_info": {
            "beneficiary_name": "Sam Rivera",
            ...
        },
        "transfer_purpose": "FAMILY_MAINTENANCE",
        "is_self_transfer": false,
        ...
    }
}'

The other destination fields depend on the route. See Transfer Requirements.

Save It in a Recipient

If you save the beneficiary as a Recipient, store is_self_transfer in its payload with the other details, so you don't have to send it with every transfer. In this example, Sam Rivera is saved as a third party:

curl --location --request POST 'https://harbor-sandbox.owlpay.com/api/v1/applications/recipients' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-API-KEY: {{API_KEY}}' \
--header 'X-Idempotency-Key: {{Idempotency-Key}}' \
--data-raw '{
    "name": "Sam Rivera - SPEI",
    "payload": {
        "destination.beneficiary_info.beneficiary_name": "Sam Rivera",
        ...,
        "destination.is_self_transfer": false
    }
}'

When you create a transfer with this recipient, is_self_transfer is sent as false.


Did this page help you?