Bacs Direct Debit

Learn how to use Payment Method Sessions to save payment method details for future Bacs Direct Debit payments.

You will need to use Payment Method Sessions API to collect Bacs Direct Debit payment details.

1. Create a payment method session

You'll need to supply the ID of the customer you'd like to attach the payment method.

curl https://api.yorlet.com/v1/payment_method_sessions \
-H "Authorization: Bearer {{API_KEY}}" \
-H "Content-Type: application/json" \
-d '{
"customer": "cus_kowie32023325",
"payment_method_types": ["bacs_debit"],
"return_url": "https://example.com/success"
}'

When you provide a return_url Yorlet will redirect the customer after they have successfully completed the payment method session.

{
"object": "payment_method_session",
"created": 1607473397,
"url": "https://pay.yorlet.com/payment_methods/pmsess_kfpOalkieq092Pm"
}

2. Redirect the customer to collect their payment details

Once you're created the payment method session you should redirect your customer to the url returned in the response so they can enter their payment details.

The Bacs Direct Debit rules require that customers are sent an email notification when payment details are collected. These emails are sent automatically by Yorlet, you can customise the branding of the emails in your account settings.

3. Retrieve the payment method

curl https://api.yorlet.com/v1/payment_method_sessions/pmsess_kopfaoko02plaQ \
-H "Authorization: Bearer {{API_KEY}}" \

The payment method session will include a payment_method you can use in future requests. You can also use the list all payment methods API to see payment methods for a particular customer.

Timing

It can take up to 3 business days to confirm whether a Bacs Direct Debit payment has succeeded or failed. Payments that are made after 20:00 UTC are submitted the following day.

Time

Event

Day 0 (before 20:00)

The payment is submitted

Day 2

The funds leave the customers account

Day 3

The funds settle to your Yorlet account