Skip to main content
Reject Beneficiary
curl --request POST \
  --url https://api.yapily.com/users/{userId}/beneficiaries/{beneficiaryId}/reject \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "meta": {
    "tracingId": "e7b7636d-a041-4013-8a1b-34dc85b7d341"
  },
  "data": {
    "beneficiaryId": "a5cc1d07-dd0b-469f-8ebd-f580e8314efd",
    "details": {
      "name": "Albert",
      "match": {
        "status": "NO_MATCH"
      },
      "accountIdentifier": {
        "type": "IBAN",
        "identification": "GB33BUKB2020155555555"
      }
    }
  }
}
'
import requests

url = "https://api.yapily.com/users/{userId}/beneficiaries/{beneficiaryId}/reject"

payload = {
    "meta": { "tracingId": "e7b7636d-a041-4013-8a1b-34dc85b7d341" },
    "data": {
        "beneficiaryId": "a5cc1d07-dd0b-469f-8ebd-f580e8314efd",
        "details": {
            "name": "Albert",
            "match": { "status": "NO_MATCH" },
            "accountIdentifier": {
                "type": "IBAN",
                "identification": "GB33BUKB2020155555555"
            }
        }
    }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    meta: {tracingId: 'e7b7636d-a041-4013-8a1b-34dc85b7d341'},
    data: {
      beneficiaryId: 'a5cc1d07-dd0b-469f-8ebd-f580e8314efd',
      details: {
        name: 'Albert',
        match: {status: 'NO_MATCH'},
        accountIdentifier: {type: 'IBAN', identification: 'GB33BUKB2020155555555'}
      }
    }
  })
};

fetch('https://api.yapily.com/users/{userId}/beneficiaries/{beneficiaryId}/reject', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.yapily.com/users/{userId}/beneficiaries/{beneficiaryId}/reject",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'meta' => [
        'tracingId' => 'e7b7636d-a041-4013-8a1b-34dc85b7d341'
    ],
    'data' => [
        'beneficiaryId' => 'a5cc1d07-dd0b-469f-8ebd-f580e8314efd',
        'details' => [
                'name' => 'Albert',
                'match' => [
                                'status' => 'NO_MATCH'
                ],
                'accountIdentifier' => [
                                'type' => 'IBAN',
                                'identification' => 'GB33BUKB2020155555555'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.yapily.com/users/{userId}/beneficiaries/{beneficiaryId}/reject"

	payload := strings.NewReader("{\n  \"meta\": {\n    \"tracingId\": \"e7b7636d-a041-4013-8a1b-34dc85b7d341\"\n  },\n  \"data\": {\n    \"beneficiaryId\": \"a5cc1d07-dd0b-469f-8ebd-f580e8314efd\",\n    \"details\": {\n      \"name\": \"Albert\",\n      \"match\": {\n        \"status\": \"NO_MATCH\"\n      },\n      \"accountIdentifier\": {\n        \"type\": \"IBAN\",\n        \"identification\": \"GB33BUKB2020155555555\"\n      }\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.yapily.com/users/{userId}/beneficiaries/{beneficiaryId}/reject")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"meta\": {\n    \"tracingId\": \"e7b7636d-a041-4013-8a1b-34dc85b7d341\"\n  },\n  \"data\": {\n    \"beneficiaryId\": \"a5cc1d07-dd0b-469f-8ebd-f580e8314efd\",\n    \"details\": {\n      \"name\": \"Albert\",\n      \"match\": {\n        \"status\": \"NO_MATCH\"\n      },\n      \"accountIdentifier\": {\n        \"type\": \"IBAN\",\n        \"identification\": \"GB33BUKB2020155555555\"\n      }\n    }\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.yapily.com/users/{userId}/beneficiaries/{beneficiaryId}/reject")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"meta\": {\n    \"tracingId\": \"e7b7636d-a041-4013-8a1b-34dc85b7d341\"\n  },\n  \"data\": {\n    \"beneficiaryId\": \"a5cc1d07-dd0b-469f-8ebd-f580e8314efd\",\n    \"details\": {\n      \"name\": \"Albert\",\n      \"match\": {\n        \"status\": \"NO_MATCH\"\n      },\n      \"accountIdentifier\": {\n        \"type\": \"IBAN\",\n        \"identification\": \"GB33BUKB2020155555555\"\n      }\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "meta": {
    "tracingId": "e7b7636d-a041-4013-8a1b-34dc85b7d341"
  },
  "data": {
    "beneficiaryId": "a5cc1d07-dd0b-469f-8ebd-f580e8314efd",
    "status": "REJECTED",
    "details": {
      "name": "Albert",
      "match": {
        "status": "NO_MATCH"
      },
      "accountIdentifier": {
        "type": "IBAN",
        "identification": "GB33BUKB2020155555555"
      }
    }
  }
}
{
  "error": {
    "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
    "code": 400,
    "status": "BAD_REQUEST",
    "supportUrl": "https://support.yapily.com/",
    "source": "YAPILY",
    "issues": [
      {
        "type": "BAD_REQUEST",
        "code": 10600,
        "message": "The server could not understand the request due to invalid syntax"
      }
    ]
  }
}
{
  "error": {
    "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
    "code": 400,
    "status": "BAD_REQUEST",
    "supportUrl": "https://support.yapily.com/",
    "source": "YAPILY",
    "issues": [
      {
        "type": "BAD_REQUEST",
        "code": 10600,
        "message": "The server could not understand the request due to invalid syntax"
      }
    ]
  }
}
{
  "error": {
    "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
    "code": 400,
    "status": "BAD_REQUEST",
    "supportUrl": "https://support.yapily.com/",
    "source": "YAPILY",
    "issues": [
      {
        "type": "BAD_REQUEST",
        "code": 10600,
        "message": "The server could not understand the request due to invalid syntax"
      }
    ]
  }
}
{
  "error": {
    "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
    "code": 400,
    "status": "BAD_REQUEST",
    "supportUrl": "https://support.yapily.com/",
    "source": "YAPILY",
    "issues": [
      {
        "type": "BAD_REQUEST",
        "code": 10600,
        "message": "The server could not understand the request due to invalid syntax"
      }
    ]
  }
}
Learn more: Verification of Payee

Authorizations

​
Authorization
string
header
required

Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.

Headers

​
sub-application
string<uuid>

The sub-application ID to which event type is being subscribed to

Path Parameters

​
beneficiaryId
string<uuid>
required

Beneficiary Id

Example:

"e7b7636d-a041-4013-8a1b-34dc85b7d341"

​
userId
string<uuid>
required
Example:

"e7b7636d-a041-4013-8a1b-34dc85b7d341"

Body

application/json

Beneficiary request with the details of the VoP result.

​
name
string
required

name of the beneficiary

Example:

"John Doe"

​
accountIdentifier
object
required

Account's details.

​
match
object

Details of the match given by the institution.

Response

OK.

The user beneficiary response.

​
meta
object
​
data
object

Beneficiary data response.