Skip to main content
Create application beneficiary
curl --request POST \
  --url https://api.yapily.com/applications/{applicationId}/beneficiaries \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Doe",
  "accountIdentifier": {
    "type": "IBAN",
    "identification": "DE12345123451234512345123"
  }
}
'
{
  "meta": {
    "tracingId": "<string>"
  },
  "data": {
    "beneficiaryId": "e7b7636d-a041-4013-8a1b-34dc85b7d341",
    "details": {
      "name": "John Doe",
      "accountIdentifier": {
        "type": "IBAN",
        "identification": "DE12345123451234512345123"
      }
    }
  }
}

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.

Path Parameters

applicationId
string<uuid>
required

Yapily application Id

Example:

"6d97cf35-1000-4787-af16-7100912db9e4"

Body

application/json

The beneficiary to be created.

Application beneficiary details.

name
string
required

beneficiary name

Example:

"John Doe"

accountIdentifier
object
required

Account's details.

Response

OK

Application beneficiary response.

meta
object
data
object

Application beneficiary data response.