Payins
Manage the templates that configure collections and read the resulting payins
Endpoints for collecting money into your accounts. A template is a reusable configuration that defines how payments are collected, an intent is a single expected payment declared before the funds arrive, and a payin is the incoming payment itself. A settlement batch is the movement that delivers the funds of many payins to your funding account.
Templates
A template is tied to a subaccount and defines the accepted payment methods, amount limits, expected payers and expiration for the payins collected against it.
GET /v1/core/payins/templates
Lists templates
POST /v1/core/payins/templates
Creates a template
GET /v1/core/payins/templates/{id}
Gets a template
PATCH /v1/core/payins/templates/{id}
Updates a template
DELETE /v1/core/payins/templates/{id}
Deletes a template
Intents
An intent is a single expected payment declared before the funds arrive. It is created against a template and tracked until it is paid, fails, or expires.
GET /v1/core/payins/intents
Lists intents
POST /v1/core/payins/intents
Creates an intent
GET /v1/core/payins/intents/{id}
Gets an intent
GET /v1/core/payins/intents/find_successful_by
Finds the successful intent for an external_id
Payins
A payin is a payment received from a payer against one of your templates.
Settlement batches
A settlement batch is the single money movement that delivers the funds of many payins to your funding account.
GET /v1/core/payins/settlement_batches
Lists settlement batches
GET /v1/core/payins/settlement_batches/{id}
Gets a settlement batch
Brands
A brand is what the hosted checkout wears: the merchant name, logo, and color a payer sees when paying one of your templates. Every template wears a brand.
Sandbox
These endpoints are only available in the sandbox environment. Use them to simulate a payer paying a template or an intent, and to provoke the failures you need to test.