Skip to main content
GET
/
v1
/
recipients
/
{id}
Get recipient
curl --request GET \
  --url https://api.example.com/v1/recipients/{id} \
  --header 'Authorization: Bearer <token>'
{
  "iban": "<string>",
  "legal_name": "<string>",
  "country": "<string>",
  "city": "<string>",
  "legal_address": "<string>",
  "bic": "<string>",
  "bank": "<string>",
  "type": "business",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "intermediate_bic": "<string>",
  "intermediate_bank": "<string>",
  "intermediate_route": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "reference": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Response

Recipient retrieved successfully

​
iban
string
required
​
legal_name
string
required
​
country
string
required
Required string length: 2
​
city
string
required
​
legal_address
string
required
​
bic
string
required
Pattern: ^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$
​
bank
string
required
​
type
enum<string>
required
Available options:
business,
personal
​
id
string<uuid>
required
​
customer_id
string<uuid>
required
​
intermediate_bic
string
Pattern: ^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$
​
intermediate_bank
string
​
intermediate_route
string
​
email
string<email>
​
phone
string
​
reference
string