Skip to content
Banking as a Service
/
/
Creates a new counter par...

Overview

Our Banking as a Service (BaaS) platform helps to make it simple for companies to handle the flow of money. Our APIs offer a safe and dependable way to manage your financial operations, whether you are seeking money from a partner or paying somebody else.

With these APIs, you can:

  • Manage Payees: Securely save the details of people or businesses you work with, including their bank information for ACH, Wire, or Braid transfers.
  • Move Money: Create and send payment requests quickly by specifying the amount and the preferred payment method.
  • Track Activity: Search through your transaction history to monitor the status of your payments and keep your records up to date.
Download OpenAPI description
braid.json
braid.yaml
Overview
API Support
support@theropay.io
Languages
Servers
Mock server
https://docs.theropay.co/_mock/theropay/docs/reference/braid
Sandbox Server
https://devapi.theropay.co

Business

Manage your business partners and counterparties. Use these APIs to create and store information about the people or companies you interact with, including their bank details.

Operations

Generate a Token

Request

This API generates an access token using the clientId and clientSecret.

Security
Bearer
Body
required
clientIdstringrequired

(Required) Unique identifier assigned to the client application

clientSecretstringrequired

(Required) Secret key associated with the clientId for authentication.

curl -i -X POST \
  https://docs.theropay.co/_mock/theropay/docs/reference/braid/api/v1/generate-token \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "clientId": "string",
    "clientSecret": "string"
  }'

Responses

OK

Bodyapplication/json
clientIdstring
clientSecretstring
Response
application/json
{
  "clientId": "string",
  "clientSecret": "string"
}

Creates a new counter party

Request

Security
Bearer
Body

Registers a new Counterparty (payee) within the Theropay ecosystem. This is a required first step before initiating any financial transfers.Request object containing payee details.

  • Allows you to attach payment details for ACH, Wire network via the nested objects.
One of:
namestringnon-emptyrequired
phonestringrequired
emailstringrequired
businessIdinteger

required for business counter-party

PaymentMethodTypestring
Enum"STANDARD""SAME_DAY"
typestringrequired
Enum"INDIVIDUAL""BUSINESS"
productIdinteger or null

optional

dateOfBirthstring(date)

optional for BUSINESS but required for INDIVIDUAL

idNumberstring or null

optional

idTypestring or null

optional

dbaNamestring

optional

jurisdictionStatestring

optional for INDIVIDUAL but required for BUSINESS

jurisdictionCountrystring

Required only for US Jurisdiction country

individualIdinteger or null

optional

achobject(AchRequest)
curl -i -X POST \
  https://docs.theropay.co/_mock/theropay/docs/reference/braid/finance/v1/payee \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "phone": "string",
    "email": "string",
    "businessId": 0,
    "PaymentMethodType": "STANDARD",
    "type": "INDIVIDUAL",
    "productId": 0,
    "dateOfBirth": "2019-08-24",
    "idNumber": "string",
    "idType": "string",
    "dbaName": "string",
    "jurisdictionState": "string",
    "jurisdictionCountry": "string",
    "individualId": 0,
    "ach": {
      "accountNumber": "string",
      "address": {
        "city": "string",
        "countryCode": "string",
        "line1": "string",
        "line2": "string",
        "postalCode": "string",
        "state": "string",
        "type": "string"
      },
      "bankAccountType": "CHECKING",
      "bankName": "string",
      "gatewayRoutingNumber": "string",
      "rdfiNumberQualifier": "string",
      "routingNumber": "string"
    }
  }'

Responses

Counterparty created successfully

Payment

Initiate and handle money movement. This section allows you to create new payment requests, set the transaction amount, and choose the best payment method for your needs.

Operations

Transaction

Track and monitor your financial activity. These tools allow you to search through your payment history, check the status of specific transfers, and get detailed information about any transaction.

Operations