Skip to main content
POST

Authorizations

Authorization
string
header
required

An access token (at_test_… or at_live_…) from POST https://idp.talescria.com/oauth/token.

Headers

Idempotency-Key
string
required

A unique key for this operation. Send the same key when you retry it. Kept for 24 hours.

Required string length: 8 - 255
Pattern: ^[A-Za-z0-9_\-:.]+$

Body

application/json
type
enum<string>
required

Decides which name fields are required.

Available options:
individual,
business
relationship
enum<string>
required

How you're related to the recipient: vendor, supplier, customer or employee.

Available options:
vendor,
supplier,
customer,
employee
email
string<email>
required
Maximum string length: 320
address
object
required
firstName
string

Required for an individual.

Maximum string length: 100
lastName
string

Required for an individual.

Maximum string length: 100

Required for a business.

Maximum string length: 200
tradingName
string

What the business is known as, if that differs from its legal name.

Maximum string length: 200
phone
string
Maximum string length: 32
identification
object[]

Identifying documents. A business may only be identified by business_registration; an individual by passport, drivers_license or national_id. The number is passed to the payment network and not stored by Talescria: reads return the type, the issuing country and the last four digits.

Maximum array length: 5
nickname
string

A label for the recipient at the provider, when their name is not what you call them.

Maximum string length: 200

Response

Created. destinations is an empty array.

recipient
object