Enroll Payment Method

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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 it for future purchases in the payment method object created.

Note that this request requires an X-Idempotency-Key. Check the Authentication.

📘

Webhooks

We recommend listening to Webhooks to stay up to date with the state of the enrolled payment methods of your customers.

In case a customer enrolls the same card twice but with new expiration date or cardholder info, we will unenroll the previously enrolled card and keep the new one.

Available payment methods for enrollment

The following payment methods can be enrolled using this endpoint:

Payment MethodType
CardsCARD
NupayNU_PAY_ENROLLMENT
PayPalPAYPAL_ENROLLMENT
DaviplataDAVIPLATA_ENROLLMENT
MercadoPago WalletWALLET_CONNECT
dLocal YapeYAPE_ENROLLMENT
dLocal Smart PIXSMART_PIX
AstropayASTROPAY_ENROLLABLE
Adyen PIX BiométricoPIX_BIOMETRICO
📘

Payment Method Availability

When you retrieve the payment methods available to enroll, only the ones which you have connected, created a route, and added to your checkout will be present. For more information about enrollment workflows, see the Enroll Payment Methods guide.

Path Params
string
required

The customer session that has been created for the enrollment using the Create Customer Session endpoint (UUID, 36 chars).

Body Params
string
required

The unique identifier of the account. You find this information on the Yuno dashboard (UUID, 36 chars).

string
enum
required

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

Allowed:
string
enum
required

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

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. Access the Card Verification page for more details.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json