Add beneficiary Contact
Creates new Contact to transfer money using Faster Payments or SEPA System
Endpoint
Request Type | URL |
|---|---|
POST | https://{EnvironmentURL}/contacts/customers/{customerId}/contacts |
Headers
No headers
Request parameters
Parameter | Type | Mandatory | Description |
|---|---|---|---|
customerId | uuid | Yes | Identifier of the Customer, owner of the Contact |
Request body
Body - JSON
Parameter | Type | Mandatory | Description |
|---|---|---|---|
type | string | Yes | Type of the Beneficiary Allowed values:
|
currency | string | Yes | Code of the Currency of the Beneficiary Account Allowed values:
|
accountHolderName | string | Yes | Name of Beneficiary |
details | object | Yes | Beneficiary Account details |
iban | string | Conditional | Beneficiary Account IBAN Mandatory only in case of "type" = 'IBAN' (for SEPA) |
sortCode | string | Conditional | Beneficiary Account Sort Code Applicable only in case of type = 'sort_code (for Faster Payments) |
accountNumber | string | Conditional | Beneficiary Account Number Applicable only in case of type = 'sort_code (for Faster Payments) |
legalType | string | Yes | Legal type of Beneficiary Allowed values:
|
address | object | Yes | Address of the Beneficiary |
address.country | string | Yes | Name of the Country |
address.countryCode | string | Yes | ISO 3166-1 alpha-2 code of the Country |
address.state | string | No | State, if applicable for Country |
address.city | string | Yes | Name of the City |
address.postcode | string | No | Postcode |
address.firstline | string | Yes | Address line |
Request example
{
type: "sort_code",
currency: "gbp",
accountHolderName: "John Doe",
details: {
sortCode: "00778899",
accountNumber: "555434343",
legalType: "PRIVATE",
address: {
country: "United Kingdom",
countryCode: "UK",
city: "London",
postCode: "777888",
firstLine: "Address"
}
}
}
Responses
200 OK - Success
Created Contact object with identifier
400 Bad request
Invalid format of the request
422 Client error
Internal business rules error
Body - Problem details
401 - Unauthorized
No Body