payment-instruments
Register a payment instrument for a customer
Accepts a Basis Theory vault token reference (vaultToken.id, vaultToken.provider, vaultToken.kind, optional vaultToken.fingerprint). Optional metadata is stored on the payment instrument (max 50 keys, 64 characters per key, 16KB serialized).
POST
/
payment-instruments
Register a payment instrument for a customer
curl --request POST \
--url https://api-sandbox.paygood.co/payment-instruments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"vaultToken": {
"id": "bt_card_token_abc123",
"provider": "basistheory",
"kind": "token_intent",
"fingerprint": "fp_card_abc123"
},
"instrumentHolderName": "Amina Diallo",
"customerId": "cust_01hxy8m1nqk9g3x3y3p0azq2zz",
"billingAddress": {
"line1": "123 Main St",
"city": "Minneapolis",
"region": "MN",
"postalCode": "55401",
"country": "US"
}
}
'import requests
url = "https://api-sandbox.paygood.co/payment-instruments"
payload = {
"vaultToken": {
"id": "bt_card_token_abc123",
"provider": "basistheory",
"kind": "token_intent",
"fingerprint": "fp_card_abc123"
},
"instrumentHolderName": "Amina Diallo",
"customerId": "cust_01hxy8m1nqk9g3x3y3p0azq2zz",
"billingAddress": {
"line1": "123 Main St",
"city": "Minneapolis",
"region": "MN",
"postalCode": "55401",
"country": "US"
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
vaultToken: {
id: 'bt_card_token_abc123',
provider: 'basistheory',
kind: 'token_intent',
fingerprint: 'fp_card_abc123'
},
instrumentHolderName: 'Amina Diallo',
customerId: 'cust_01hxy8m1nqk9g3x3y3p0azq2zz',
billingAddress: {
line1: '123 Main St',
city: 'Minneapolis',
region: 'MN',
postalCode: '55401',
country: 'US'
}
})
};
fetch('https://api-sandbox.paygood.co/payment-instruments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.paygood.co/payment-instruments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'vaultToken' => [
'id' => 'bt_card_token_abc123',
'provider' => 'basistheory',
'kind' => 'token_intent',
'fingerprint' => 'fp_card_abc123'
],
'instrumentHolderName' => 'Amina Diallo',
'customerId' => 'cust_01hxy8m1nqk9g3x3y3p0azq2zz',
'billingAddress' => [
'line1' => '123 Main St',
'city' => 'Minneapolis',
'region' => 'MN',
'postalCode' => '55401',
'country' => 'US'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.paygood.co/payment-instruments"
payload := strings.NewReader("{\n \"vaultToken\": {\n \"id\": \"bt_card_token_abc123\",\n \"provider\": \"basistheory\",\n \"kind\": \"token_intent\",\n \"fingerprint\": \"fp_card_abc123\"\n },\n \"instrumentHolderName\": \"Amina Diallo\",\n \"customerId\": \"cust_01hxy8m1nqk9g3x3y3p0azq2zz\",\n \"billingAddress\": {\n \"line1\": \"123 Main St\",\n \"city\": \"Minneapolis\",\n \"region\": \"MN\",\n \"postalCode\": \"55401\",\n \"country\": \"US\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.paygood.co/payment-instruments")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"vaultToken\": {\n \"id\": \"bt_card_token_abc123\",\n \"provider\": \"basistheory\",\n \"kind\": \"token_intent\",\n \"fingerprint\": \"fp_card_abc123\"\n },\n \"instrumentHolderName\": \"Amina Diallo\",\n \"customerId\": \"cust_01hxy8m1nqk9g3x3y3p0azq2zz\",\n \"billingAddress\": {\n \"line1\": \"123 Main St\",\n \"city\": \"Minneapolis\",\n \"region\": \"MN\",\n \"postalCode\": \"55401\",\n \"country\": \"US\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.paygood.co/payment-instruments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"vaultToken\": {\n \"id\": \"bt_card_token_abc123\",\n \"provider\": \"basistheory\",\n \"kind\": \"token_intent\",\n \"fingerprint\": \"fp_card_abc123\"\n },\n \"instrumentHolderName\": \"Amina Diallo\",\n \"customerId\": \"cust_01hxy8m1nqk9g3x3y3p0azq2zz\",\n \"billingAddress\": {\n \"line1\": \"123 Main St\",\n \"city\": \"Minneapolis\",\n \"region\": \"MN\",\n \"postalCode\": \"55401\",\n \"country\": \"US\"\n }\n}"
response = http.request(request)
puts response.read_body{
"paymentInstrumentId": "<string>",
"type": "card",
"displayDetails": {
"kind": "card",
"brand": "<string>",
"last4": "<string>",
"expiryMonth": 0,
"expiryYear": 0
},
"status": "pending",
"createdAt": "2023-11-07T05:31:56Z",
"metadata": {}
}Authorizations
Merchant API key bearer token.
Headers
Client-supplied unique key for safe retries of this mutating request. Scoped per merchant or resource as documented on each endpoint.
Example:
"idem-01"
Body
application/json
Payment instrument registration payload. vaultToken requires id, provider, and kind; fingerprint is optional when the Element provides it.
Response
201 - application/json
Available options:
card, bank_account - Option 1
- Option 2
Show child attributes
Show child attributes
Available options:
pending, active, failed, disabled Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Show child attributes
Show child attributes
⌘I
Register a payment instrument for a customer
curl --request POST \
--url https://api-sandbox.paygood.co/payment-instruments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"vaultToken": {
"id": "bt_card_token_abc123",
"provider": "basistheory",
"kind": "token_intent",
"fingerprint": "fp_card_abc123"
},
"instrumentHolderName": "Amina Diallo",
"customerId": "cust_01hxy8m1nqk9g3x3y3p0azq2zz",
"billingAddress": {
"line1": "123 Main St",
"city": "Minneapolis",
"region": "MN",
"postalCode": "55401",
"country": "US"
}
}
'import requests
url = "https://api-sandbox.paygood.co/payment-instruments"
payload = {
"vaultToken": {
"id": "bt_card_token_abc123",
"provider": "basistheory",
"kind": "token_intent",
"fingerprint": "fp_card_abc123"
},
"instrumentHolderName": "Amina Diallo",
"customerId": "cust_01hxy8m1nqk9g3x3y3p0azq2zz",
"billingAddress": {
"line1": "123 Main St",
"city": "Minneapolis",
"region": "MN",
"postalCode": "55401",
"country": "US"
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
vaultToken: {
id: 'bt_card_token_abc123',
provider: 'basistheory',
kind: 'token_intent',
fingerprint: 'fp_card_abc123'
},
instrumentHolderName: 'Amina Diallo',
customerId: 'cust_01hxy8m1nqk9g3x3y3p0azq2zz',
billingAddress: {
line1: '123 Main St',
city: 'Minneapolis',
region: 'MN',
postalCode: '55401',
country: 'US'
}
})
};
fetch('https://api-sandbox.paygood.co/payment-instruments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.paygood.co/payment-instruments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'vaultToken' => [
'id' => 'bt_card_token_abc123',
'provider' => 'basistheory',
'kind' => 'token_intent',
'fingerprint' => 'fp_card_abc123'
],
'instrumentHolderName' => 'Amina Diallo',
'customerId' => 'cust_01hxy8m1nqk9g3x3y3p0azq2zz',
'billingAddress' => [
'line1' => '123 Main St',
'city' => 'Minneapolis',
'region' => 'MN',
'postalCode' => '55401',
'country' => 'US'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.paygood.co/payment-instruments"
payload := strings.NewReader("{\n \"vaultToken\": {\n \"id\": \"bt_card_token_abc123\",\n \"provider\": \"basistheory\",\n \"kind\": \"token_intent\",\n \"fingerprint\": \"fp_card_abc123\"\n },\n \"instrumentHolderName\": \"Amina Diallo\",\n \"customerId\": \"cust_01hxy8m1nqk9g3x3y3p0azq2zz\",\n \"billingAddress\": {\n \"line1\": \"123 Main St\",\n \"city\": \"Minneapolis\",\n \"region\": \"MN\",\n \"postalCode\": \"55401\",\n \"country\": \"US\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.paygood.co/payment-instruments")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"vaultToken\": {\n \"id\": \"bt_card_token_abc123\",\n \"provider\": \"basistheory\",\n \"kind\": \"token_intent\",\n \"fingerprint\": \"fp_card_abc123\"\n },\n \"instrumentHolderName\": \"Amina Diallo\",\n \"customerId\": \"cust_01hxy8m1nqk9g3x3y3p0azq2zz\",\n \"billingAddress\": {\n \"line1\": \"123 Main St\",\n \"city\": \"Minneapolis\",\n \"region\": \"MN\",\n \"postalCode\": \"55401\",\n \"country\": \"US\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.paygood.co/payment-instruments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"vaultToken\": {\n \"id\": \"bt_card_token_abc123\",\n \"provider\": \"basistheory\",\n \"kind\": \"token_intent\",\n \"fingerprint\": \"fp_card_abc123\"\n },\n \"instrumentHolderName\": \"Amina Diallo\",\n \"customerId\": \"cust_01hxy8m1nqk9g3x3y3p0azq2zz\",\n \"billingAddress\": {\n \"line1\": \"123 Main St\",\n \"city\": \"Minneapolis\",\n \"region\": \"MN\",\n \"postalCode\": \"55401\",\n \"country\": \"US\"\n }\n}"
response = http.request(request)
puts response.read_body{
"paymentInstrumentId": "<string>",
"type": "card",
"displayDetails": {
"kind": "card",
"brand": "<string>",
"last4": "<string>",
"expiryMonth": 0,
"expiryYear": 0
},
"status": "pending",
"createdAt": "2023-11-07T05:31:56Z",
"metadata": {}
}