Payment Source routes: get, list, update
The Payment Source Verbs get, list, update as api.sb routes, with inputs, result, refusals and an example.
Reference for Payment Source, one group of Payment Source routes.
PaymentSource.get
Returns one Payment Source by id. Verb page.
GET /{namespace}/Path: id. Query: the other inputs. Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Payment Source. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
paymentSource | Payment Source | required | The Payment Source. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
curl https:{
"api": "https:PaymentSource.list
Returns Payment Sources, newest first, one page at a time. Verb page.
GET /{namespace}/Query: the inputs. Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
limit | integer | At most this many records, up to 100. The default is 20. | |
after | string | The cursor from the previous page. | |
where | string | A filter over the properties, such as paidAt = null and total.amount > 500. | |
sort | string | Properties to sort by, comma-separated; a leading minus sorts descending. | |
total | boolean | True adds the match count as meta.total, exact up to 10,000 matches and estimated above. | |
facets | string | Properties to count by value, comma-separated, returned as meta.facets. | |
fields | string | Properties to return on each record, comma-separated; $id and $type always return. | |
include | string | Related records to embed in place of their URLs, comma-separated. | |
depth | integer | How many levels of related records to embed. The default is 1. | |
q | string | Words to match across the text properties, ranked by relevance. | |
match | string | Ranks the search by words, or meaning; words is the default. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
paymentSources | list of Payment Source | required | One page of Payment Sources. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
curl "https:{
"api": "https:PaymentSource.update
Changes the given properties of a Payment Source. Verb page.
PATCH /{namespace}/Path: id. Body, as JSON: the other inputs. Emits PaymentSource.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Payment Source. |
kind | string | How it pays: a card, a bank debit from the Customer’s account, or a wallet on the Customer’s phone or browser. | |
label | string | What the Customer sees, such as the card brand and last four digits; never the full number. | |
expiresOn | date | When a card expires; the billing portal asks for a new one 30 days before. | |
default | boolean | True for the one Payment Source that new Invoices and renewals charge. | |
removedAt | datetime | When the Customer removed it; nothing charges it after, and the record stays. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
paymentSource | Payment Source | required | The Payment Source. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
curl -X PATCH https:{
"api": "https: