Skip to main content
POST
This request enrolls a payment method for a customer. With the information provided by Yuno after the customer selects the payment method to enroll, you will be able to save that information for future purchases using the payment method object created. Check the Available payment methods in Yuno. You’ll need to set your credentials for each payment method in the Yuno dashboard in order to be able to use them. Note that this request requires an X-Idempotency-Key. Check the Authentication page for more information.
WebhooksWe recommend listening to Webhooks to stay up to date with the state of the enrolled payment methods of your customers.
If a customer enrolls the same card multiple times, Yuno creates a new enrollment each time and returns a distinct vaulted_token. Use the card fingerprint in the enrollment response to detect duplicates on your side (the fingerprint may be null for some providers). See Card Fingerprint.
Only available for PCI certified merchants.

Authorizations

public-api-key
string
header
default:<Your public-api-key>
required
private-secret-key
string
header
default:<Your private-secret-key>
required
X-Idempotency-Key
string
header
default:<Your X-Idempotency-Key>
required

Path Parameters

customer_id
string
required

The unique identifier of the customer, created using the Create Customer endpoint (MAX 64; MIN 36).

Body

application/json
account_id
string
required

The unique identifier of the account. You find this information on Yuno's Dashboard (MAX 64; MIN 36).

country
enum<string>
required

The transaction's country code (MAX 2; MIN 2; ISO 3166-1).

Available options:
AR,
BO,
BR,
CL,
CO,
CR,
EC,
SV,
GT,
HN,
MX,
NI,
PA,
PY,
PE,
US,
UY
type
enum<string>
required

The payment method type (MAX 255; MIN 3; Payment type).

Available options:
CARD,
ACH_ENROLLMENT,
NU_PAY_ENROLLMENT,
SEPA_ENROLLMENT
workflow
enum<string>
default:DIRECT

The payment workflow indicates whether the integration will use Yuno's SDK or will be a back to back connection. Since you are in the Direct workflow, the value must be DIRECT.

Available options:
DIRECT
callback_url
string

URL to return the customer after an enrollment in a provider´s environment. Only necessary for alternative payment methods integrations (MAX 255; MIN 3).

metadata
object[]

Optional custom key–value tags for the enrollment (e.g., on_behalf_of, order_ref). Opaque to Yuno: it is stored with the enrolled payment method, returned when you retrieve it and on the enrollment.enroll webhook, and sent to the provider integration with the enrollment, the same way payment metadata reaches it on a charge. The reserved gateway_options entry is the exception: it is stored and returned, but it is not forwarded with the enrollment. Up to 120 items and 75000 characters in total, counting every key and value.

token
string<uuid>

Pre-generated token used to reference the payment method being enrolled.

parent_type
string

Type of the parent payment method, used when enrolling a tokenized/derived method (e.g. CARD).

account_updater
boolean

Per-card control for Card Account Updater. When set to false, this card is excluded from Card Account Updater and will not receive automatic card-detail updates. When omitted, the card follows your account's Account Updater configuration. Applies at enrollment.

card_data
object

Specifies the details of the card. Only for DIRECT workflow integration.

customer_payer
object

Information about the customer/payer associated with the payment method.

payment_method
object

Payment method wrapper used for non-card methods (e.g. bank transfer / ACH) and vaulting options.

provider_data
object

Provider data used for token migration or provider-token enrollment. Send this object when token_source is PROVIDER_API, MIGRATION_FILE, or PROVIDER_TOKEN. Usage must be agreed with your commercial advisor in Yuno.

verify
object

Indicates whether to verify the payment with a verify transaction or not. You’ll need to have a provider defined in your CARD route. False by default.

recurring_payment
object

Recurring / subscription billing metadata associated with the enrolled method.

Response

201

idempotency_key
string
Example:

"2ca58c6d-8794-4c8f-a2f6-bba4b7498b74"

name
string
Example:

"VISA ****1111"

description
string
Example:

"VISA ****1111"

type
string
Example:

"CARD"

category
string
Example:

"CARD"

country
string
Example:

"US"

status
string
Example:

"ENROLLED"

sub_status
any
vaulted_token
string
Example:

"cbdcc878-ceb4-4dd8-b0f0-49d444855de0"

metadata
array
callback_url
string
Example:

"www.example.com"

action
string
redirect_url
string
Example:

null

parent_type
string
Example:

"CARD"

created_at
string
Example:

"2024-06-06T13:32:49.715656Z"

updated_at
string
Example:

"2024-06-06T13:32:49.715656Z"

card_data
object
last_successfully_used
any
last_successfully_used_at
any
preferred
any
verify
object
provider_data
object

Additional data from the provider