Quick Start

Getting Started
Payments
Card on File
Interac Payments (Canada)
Best Practices
- Error Handling
- Processing Best Practice

Quilt Payments API

Accounts
Payments
Customers
Locations
Readers / Terminals
Reports
Webhooks
Terminal API (Internal)
- /v2/payment/details/{payment_id}get
- /v2/payment/statusput

Quick Start

Getting Started
Payments
Card on File
Interac Payments (Canada)
Best Practices
- Error Handling
- Processing Best Practice

Quilt Payments API

Accounts
Payments
Customers
Locations
Readers / Terminals
Reports
Webhooks
Terminal API (Internal)
- /v2/payment/details/{payment_id}get
- /v2/payment/statusput

Customer card ADD [Stripe]

post https://example.com/v2/customer/card

Adds a payment method to a customer card-on-file for re-occurring billing and card-on-file payments. Stripe only.

URL Expired

The URL for this request expired after 30 days.

Body Params

Add card params

external_account_id

string

required

Defaults to null

Your business/store ID that maps to the account

external_customer_id

string

required

Your unique customer ID. This could also be an email address or any other identifier.

payment_id

string

The payment with the payment method to be added on file. If this is empty, then payment_method_id is required.

payment_method_id

string

The payment method ID to be added on file. If this is empty, then payment_id is required.

customer_name

string

Optional but helpful when referencing payment information and only when creating customer at the same time as adding the card

customer_email

string

Optional but very helpful when referencing payment information and only needed when creating the customer at the same time as adding the card

Responses

Response body

object

customer

object

Customer details.

customer_id

string

Our unique ID for the customer. Required when making card-on-file payments.

external_customer_id

string

Your unique customer ID. This could also be an email address or any other identifier.

name

string

Customer's name

string

Customers email

cards

array of objects

cards

object

customer_id

string

Our unique ID for the customer

external_customer_id

string

Your unique customer ID. This could also be an email address or any other identifier.

payment_method_id

string

Unique ID for for the payment method

brand

string

The card brand.

last_4

string

The last 4 digits of the card number

exp_month

string

The month the card expires. 2 digits 0 filled.

exp_year

string

The year the card expires. 4 digits.

fingerprint

string

Card fingerprint.

payment

object

payment_method_id

string

Unique ID for the payment method

brand

string

The card brand.

last_4

string

The last 4 digits of the card number.

exp_month

string

The month the card expires. 2 digits 0 filled.

exp_year

string

The year the card expires. 4 digits.

cardholder_name

string

The name of the card holder if available

billing_name

string

Name associated with billing information for this card

billing_email

string

Email associated with billing information for this card

fingerprint

string

The fingerprint for this card.

charge_id

string

The charge id associated with the payment. Needed for Interac payment refunds.

avs_response

string

The AVS response from the processor

request_id

number

Unique identifier for the request which can be used to lookup the request in our logs

Response body

object

error

string

Response body

object

error

string

Response body

object

error

string

Updated over 1 year ago

Customer cards GET

Reassign a customer card. [Adyen]

Did this page help you?

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://example.com/v2/customer/card \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "external_account_id": null
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

Customer cards GET

Reassign a customer card. [Adyen]

Did this page help you?

Quick Start
Getting Started
Terminology
Readers / Terminals - Stripe
Readers / Terminals - Adyen
Readers / Terminals - P5
JWT Tokens
Payments
Terminal Simulation - Stripe
Payment (CNP) Stripe
Payment (CP) - Stripe
Duplicate Protection (CP) - Adyen
Error Handling - Adyen
Testing - Adyen
Terminal Simulation - Adyen
Payments (CNP) Adyen
Payment (CP) - Adyen: S1F2/AMS1
Payment (MKE) - Adyen: P5
Payment (CP) - Adyen: P5
Card on File
Charge COF - manual capture - Adyen
Charge COF - auto capture - Adyen
Charge COF - auto capture - Stripe
Save COF - CNP - no payment collected - Stripe
Save COF - CNP - manual capture - customer later - Stripe
Save COF - CNP - Summary - Stripe
Save COF - CP - no payment collected - Stripe
Save COF - CP - manual capture - customer with intent - Stripe
Save COF - CP - auto capture - customer later - Stripe
Save COF - CP - Summary
Save COF - CNP - Adyen
Save COF - CP - Adyen
Interac Payments (Canada)
Testing Interac
Refunding Interac Payments - Stripe
Collecting Interac Payments - Stripe
Refunding Interac Payments - Adyen
Collecting Interac Payments - Adyen
Best Practices
Processing Best Practice
Error Handling

Quilt Payments API
Accounts
Setup link GETget
Account DELETE by external IDdelete
Account GET by external IDget
Donation Configuration POSTpost
Donation Configuration GETget
Approve a domainput
Account CREATEpost
Account Loginpost
Payments
EBT Balance GETget
Connection Token GETget
Payment CANCELpost
Payment REFUNDpost
Payment GET by external IDget
Payment GET by IDget
Payments GET by external IDget
Payments GETget
Payment CAPTUREpost
Payment AUTHpost
Payment UPDATEput
Payment CREATEpost
Customers
Customer card DELETEdelete
Customer Card GETget
Customer card intent CREATEpost
Customer card UPDATEput
Reassign a customer card. [Adyen]patch
Customer card ADD [Stripe]post
Customer cards GETget
Customer ADDpost
Customer GETget
Locations
Locations DELETEdelete
Location CREATEpost
Locations GETget
Readers / Terminals
Terminal REMOVEdelete
Terminal CANCELpost
Terminal Types GETget
Terminal ADDpost
Terminals GETget
Reports
Balance GETget
Payout Payments GETget
Payouts GETget
Webhooks
/v2/webhookdelete
/v2/webhookget
/v2/webhookpost
Terminal API (Internal)
/v2/payment/statusput
/v2/payment/details/{payment_id}get

Quick Start
Getting Started
Terminology
Readers / Terminals - Stripe
Readers / Terminals - Adyen
Readers / Terminals - P5
JWT Tokens
Payments
Terminal Simulation - Stripe
Payment (CNP) Stripe
Payment (CP) - Stripe
Duplicate Protection (CP) - Adyen
Error Handling - Adyen
Testing - Adyen
Terminal Simulation - Adyen
Payments (CNP) Adyen
Payment (CP) - Adyen: S1F2/AMS1
Payment (MKE) - Adyen: P5
Payment (CP) - Adyen: P5
Card on File
Charge COF - manual capture - Adyen
Charge COF - auto capture - Adyen
Charge COF - auto capture - Stripe
Save COF - CNP - no payment collected - Stripe
Save COF - CNP - manual capture - customer later - Stripe
Save COF - CNP - Summary - Stripe
Save COF - CP - no payment collected - Stripe
Save COF - CP - manual capture - customer with intent - Stripe
Save COF - CP - auto capture - customer later - Stripe
Save COF - CP - Summary
Save COF - CNP - Adyen
Save COF - CP - Adyen
Interac Payments (Canada)
Testing Interac
Refunding Interac Payments - Stripe
Collecting Interac Payments - Stripe
Refunding Interac Payments - Adyen
Collecting Interac Payments - Adyen
Best Practices
Processing Best Practice
Error Handling

Quilt Payments API
Accounts
Setup link GETget
Account DELETE by external IDdelete
Account GET by external IDget
Donation Configuration POSTpost
Donation Configuration GETget
Approve a domainput
Account CREATEpost
Account Loginpost
Payments
EBT Balance GETget
Connection Token GETget
Payment CANCELpost
Payment REFUNDpost
Payment GET by external IDget
Payment GET by IDget
Payments GET by external IDget
Payments GETget
Payment CAPTUREpost
Payment AUTHpost
Payment UPDATEput
Payment CREATEpost
Customers
Customer card DELETEdelete
Customer Card GETget
Customer card intent CREATEpost
Customer card UPDATEput
Reassign a customer card. [Adyen]patch
Customer card ADD [Stripe]post
Customer cards GETget
Customer ADDpost
Customer GETget
Locations
Locations DELETEdelete
Location CREATEpost
Locations GETget
Readers / Terminals
Terminal REMOVEdelete
Terminal CANCELpost
Terminal Types GETget
Terminal ADDpost
Terminals GETget
Reports
Balance GETget
Payout Payments GETget
Payouts GETget
Webhooks
/v2/webhookdelete
/v2/webhookget
/v2/webhookpost
Terminal API (Internal)
/v2/payment/statusput
/v2/payment/details/{payment_id}get

200Card Added Details

400invalid input, object invalid

401Unauthorized

404Not found