Bridge a bank account

PaykeyV1 Bridge.Link.BankAccount(, )

POST/v1/bridge/bank_account

Use Bridge to create a new paykey using a bank routing and account number as the source. This endpoint allows you to create a secure payment token linked to a specific bank account.

ParametersExpand Collapse

LinkBankAccountParams parameters

required string accountNumber

Body param: The bank account number.

required AccountType accountType

Body param

required string customerID

Body param: Unique identifier of the related customer object.

formatuuid

required string routingNumber

Body param: The routing number of the bank account.

minLength9

maxLength9

Config config

Body param

ProcessingMethod ProcessingMethod

One of the following:

SandboxOutcome SandboxOutcome

One of the following:

string? externalID

Body param: Unique identifier for the paykey in your database, used for cross-referencing between Straddle and your systems.

IReadOnlyDictionary<string, string>? metadata

Body param: Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the paykey in a structured format.

string correlationID

Header param: Optional client generated identifier to trace and debug a series of requests.

string idempotencyKey

Header param: Optional client generated value to use for idempotent requests.

maxLength40

minLength10

string requestID

Header param: Optional client generated identifier to trace and debug a request.

string straddleAccountID

Header param: For use by platforms to specify an account id and set scope of a request.

formatuuid

ReturnsExpand Collapse

class PaykeyV1:

required Data Data

required string ID

Unique identifier for the paykey.

formatuuid

required Config Config

ProcessingMethod ProcessingMethod

One of the following:

SandboxOutcome SandboxOutcome

One of the following:

required DateTimeOffset CreatedAt

Timestamp of when the paykey was created.

formatdate-time

required string Label

Human-readable label used to represent this paykey in a UI.

required string Paykey

The tokenized paykey value. This value is used to create payments and should be stored securely.

required Source Source

One of the following:

required Status Status

One of the following:

required DateTimeOffset UpdatedAt

Timestamp of the most recent update to the paykey.

formatdate-time

Balance Balance

required Status Status

One of the following:

Int? AccountBalance

Account Balance when last retrieved

formatint32

DateTimeOffset? UpdatedAt

Last time account balance was updated.

formatdate-time

BankData BankData

required string AccountNumber

Bank account number. This value is masked by default for security reasons. Use the /unmask endpoint to access the unmasked value.

required AccountType AccountType

One of the following:

required string RoutingNumber

The routing number of the bank account.

minLength9

maxLength9

string? CustomerID

Unique identifier of the related customer object.

formatuuid

DateTimeOffset? ExpiresAt

Expiration date and time of the paykey, if applicable.

formatdate-time

string? ExternalID

Unique identifier for the paykey in your database, used for cross-referencing between Straddle and your systems.

string? InstitutionName

Name of the financial institution.

IReadOnlyDictionary<string, string>? Metadata

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the paykey in a structured format.

StatusDetails StatusDetails

required DateTimeOffset ChangedAt

The time the status change occurred.

formatdate-time

required string Message

A human-readable description of the current status.

required Reason Reason

One of the following:

required Source Source

One of the following:

string? Code

The status code if applicable.

Boolean? UnblockEligible

Indicates whether this paykey is eligible for client-initiated unblocking. Only present for blocked paykeys. True when blocked due to R29 returns and not previously unblocked, false otherwise. Null when paykey is not blocked.

required ResponseMetadata Meta

Metadata about the API request, including an identifier and timestamp.

required string ApiRequestID

Unique identifier for this API request, useful for troubleshooting.

formatuuid

required DateTimeOffset ApiRequestTimestamp

Timestamp for this API request, useful for troubleshooting.

formatdate-time

required ResponseType ResponseType

Indicates the structure of the returned content.

"object" means the data field contains a single JSON object.
"array" means the data field contains an array of objects.
"error" means the data field contains an error object with details of the issue.
"none" means no data is returned.

One of the following:

Bridge a bank account

LinkBankAccountParams parameters = new()
{
    AccountNumber = "account_number",
    AccountType = AccountType.Checking,
    CustomerID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    RoutingNumber = "xxxxxxxxx",
};

var paykeyV1 = await client.Bridge.Link.BankAccount(parameters);

Console.WriteLine(paykeyV1);

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "config": {
      "processing_method": "inline",
      "sandbox_outcome": "standard"
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "label": "label",
    "paykey": "paykey",
    "source": "bank_account",
    "status": "pending",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "balance": {
      "status": "pending",
      "account_balance": 0,
      "updated_at": "2019-12-27T18:11:19.117Z"
    },
    "bank_data": {
      "account_number": "****1234",
      "account_type": "checking",
      "routing_number": "021000021"
    },
    "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "expires_at": "2019-12-27T18:11:19.117Z",
    "external_id": "external_id",
    "institution_name": "Bank of America",
    "metadata": {
      "foo": "string"
    },
    "status_details": {
      "changed_at": "2019-12-27T18:11:19.117Z",
      "message": "Bank account sucesfully validated",
      "reason": "insufficient_funds",
      "source": "watchtower",
      "code": "code"
    },
    "unblock_eligible": true
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}

Returns Examples

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "config": {
      "processing_method": "inline",
      "sandbox_outcome": "standard"
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "label": "label",
    "paykey": "paykey",
    "source": "bank_account",
    "status": "pending",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "balance": {
      "status": "pending",
      "account_balance": 0,
      "updated_at": "2019-12-27T18:11:19.117Z"
    },
    "bank_data": {
      "account_number": "****1234",
      "account_type": "checking",
      "routing_number": "021000021"
    },
    "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "expires_at": "2019-12-27T18:11:19.117Z",
    "external_id": "external_id",
    "institution_name": "Bank of America",
    "metadata": {
      "foo": "string"
    },
    "status_details": {
      "changed_at": "2019-12-27T18:11:19.117Z",
      "message": "Bank account sucesfully validated",
      "reason": "insufficient_funds",
      "source": "watchtower",
      "code": "code"
    },
    "unblock_eligible": true
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}