Send payments

Relevant webhooks

For this endpoint be sure you have registered for these webhooks:

CardPayments.Payment.Cleared

CardPayments.Payment.Completed

CardPayments.Card.Rejected

CardPayments.Payment.Failed

API reference

Push or pull funds

Endpoint: /v1/payments

POST

https://sandbox.crbcos.com/cardpayments/v1/payments

Body Parameters

cardIdstring
Description
The ID of the card, as returned by COS. Send either cardId or cardToken, not both.
cardTokenstring
Description
A randomly generated string of characters that relates to the consumer's payment card (15-38 alphanumeric characters). Send either cardId or cardToken, not both.
accountNumberstringrequired
Description
The identifier for the account, as defined in COS. This field is from 10 to 17 characters.
amountintegerrequired
Description
The amount to be transferred, in cents. For example, 10001 = $100.01.
paymentTypestringrequired
Description
The type of payment. Value is either "Push" or "Pull"
correspondingEntityobject
Description
Information about who initiated the transaction
- firstNamestringrequired
  Description
  First name
- lastNamestringrequired
  Description
  Last name
- externalAccountIdentifierstringrequired
  Description
  Account number to ensure the money movement is routed to the correct destination.
- addressobject
  Description
  Address of the corresponding entity. This block is optional. When it is provided there are required fields as indicated
  - street1stringrequired
    Description
    Address information, street apartment etc
  - street2string
    Description
    Additional address information
  - citystringrequired
    Description
    CIty full name
  - statestring
    Description
    State where corresponding entity is located
  - postalCodestringrequired
    Description
    Postal code of address where correponding entity is loacted
  - countryCodestringrequired
    Description
    2-letter ISO country code
mccstring
Description
Merchant Category Code (MCC). 4-digits that a credit card issuer uses to categorize consumer transactions for their card.
cvvstring
Description
Card Verification Value (CVV). 3 or 4-digits printed on card to help verify that the customer physically possesses the card during card-not-present transactions.
clientIdentifierstring
Description
A string that identifies the client associated with the payment. Max 50 characters
businessTypestring
Description
Business Application Indicator (BAI) -- a standardized category used to classify the nature of a business. One of BB - 'Business2Business', FD - 'Funds Disbursement ', AA - 'Account2Account', PP - 'Person2Person', CD - 'Cash Deposit', FT - 'Funds Transfer', BI - 'Bank Initiated', CP - 'Card Bill Payment' MD - 'Merchant Disbursement' WT - 'Wallet Transfer'
purposeOfPaymentstring
Description
The reason for the transaction. e.g. payroll. Needed for international.
threeDomainSecureobject
Description
3-D Secure (3DS) authentication values for this payment. The object is optional, and so is each field in it.
- ecistring
  Description
  Electronic Commerce Indicator (ECI) returned by the 3DS authentication. Exactly 2 characters.
- ucafstring
  Description
  Universal Cardholder Authentication Field (UCAF) value. Maximum 32 characters.
- cavvstring
  Description
  Cardholder Authentication Verification Value (CAVV). A hexadecimal string of exactly 40 characters (20 bytes).
- xidstring
  Description
  3DS transaction identifier (XID). Exactly 36 characters.
initiatorNamestring
Description
Per-payment merchant/sender name override for the cardholder's bank statement. Max 17 chars

Response

idstring
originalPaymentIdstring
Description
A UUID that is the primary identifier for the payment.
clientIdentifierstring
Description
A string that identifies the client associated with the payment.
amountinteger
Description
The amount to be transferred, in cents. For example, 10001 = $100.01.
paymentTypestring
Description
Indicates the direction of the payment: Push - Money sent out (e.g. disbursement to a customer) Pull - Money received (e.g. a charge to a customer's card)
statusstring
Description
One of "Created", "Pending", "Authorized", "Submitted", "Processing", "Completed", "Rejected", "Failed", "Hold", "Cleared", "Authorizing"
sourcestring
Description
Possible values are "Api" or "OpsPortal"
productIdstring
Description
A UUID that identifies the product, as defined in COS.
partnerIdstring
Description
A UUID that identifies the partner, as defined in COS.
cardIdstring
Description
A UUID that identifies the card used.
cardTokenstring
networkstring
Description
The network through which the payment is processed (e.g. Visa, Mastercard).
cardBrandstring
Description
One of "AmericanExpress", "ChinaUnionPay", "Dankort", "DinersClub", "Discover", "Hipercard", "JCB", "Laser", "Maestro", "MasterCard", "RuPay", "Solo", "Switch", "Visa", "Unknown"
panLastFourstring
Description
The last four digits of the Primary Account Number (card number).
issuerCountryCodestring
Description
A string representing the country code of the card issuer.
retrievalReferenceIdstring
Description
A unique identifier used for retrieving transaction details, often used in disputes or reconciliation.
networkTransactionIdstring
Description
The identifier the card network assigned to the transaction, as returned by the rail. Not returned when no network response was received, for example on a timeout or an early failure.
reasonCodestring
Description
A 2-digit code signifying the transaction result (approved or decline). For example, 00 means successful.
reasonDescriptionstring
Description
A string describing the transaction result. For example, Approved.
traceNumberstring
Description
A unique number assigned to a transaction from the time it leaves the merchant bank until it arrives at the cardholder bank
correspondingEntityobject
mccstring
Description
Merchant Category Code (MCC). 4-digits that a credit card issuer uses to categorize consumer transactions for their card.
merchantVerificationValuestring
Description
A value used to verify the merchant's identity.
initiatorNamestring
Description
Per-payment merchant/sender name override for the cardholder's bank statement. Max 17 chars
accountNumberstring
Description
The account number associated with the payment.
businessTypestring
Description
Business Application Indicator (BAI) -- a standardized category used to classify the nature of a business. One of BB - 'Business2Business', FD - 'Funds Disbursement ', AA - 'Account2Account', PP - 'Person2Person', CD - 'Cash Deposit', FT - 'Funds Transfer', WT - 'Wallet Transfer', CP - 'Card Bill Payment' MD - 'Merchant Disbursement' BI - 'Bank Initiated'
purposeOfPaymentstring
coreTransactionIdstring
Description
A UUID that links the payment to the core banking system.
memoPostIdstring
Description
A UUID that identifies the corresponding memo post (a temporary transaction posting).
memoPostRemovedAtstring
Description
When the memo post was removed. I.e. When the temporary hold was released.
wasRefundedboolean
Description
Boolean value indicating whether the payment has been refunded.
refundPaymentIdstring
Description
A UUID that identifies the refund transaction associated with the payment.
createdAtstring
Description
When the payment was created
authorizedOnstring
Description
When the payment was authorized by the issuing bank.
submittedOnstring
Description
When the payment was submitted to the network.
rejectedAtstring
Description
When the payment was rejected.
completedAtstring
Description
When the payment was successfully completed.
failedAtstring
Description
When the payment failed to process.
limitsEligibleOnstring
Description
When the transaction becomes eligible for limit calculations.
lastModifiedAtstring
Description
When the payment record was last modified.
threeDomainSecureEcistring
Description
The 3DS ECI value sent in threeDomainSecure.eci when the payment was created. Null if it wasn't sent.
threeDomainSecureUcafstring
Description
The 3DS UCAF value sent in threeDomainSecure.ucaf when the payment was created. Null if it wasn't sent.
threeDomainSecureCavvstring
Description
The 3DS CAVV value sent in threeDomainSecure.cavv when the payment was created. Null if it wasn't sent.
threeDomainSecureXidstring
Description
The 3DS XID value sent in threeDomainSecure.xid when the payment was created. Null if it wasn't sent.

curl

curl --location 'https://sandbox.crbcos.com/cardpayments/v1/payments' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
  "cardToken": "11FB445C487140A9BEA51457A796172A000000",
  "accountNumber": "2287979807",
  "amount": 1000,
  "paymentType": "Push",
  "correspondingEntity": {
    "firstName": "Darrin",
    "lastName": "Considine",
    "externalAccountIdentifier": "12345678901234",
    "address": {
      "street1": "2436 Bradtke Mountains",
      "street2": "",
      "city": "Marysville",
      "state": "NY",
      "postalCode": "123456789",
      "countryCode": "US"
    }
 },
  "mcc": "9876",
  "cvv": "123",
  "clientIdentifier": "string",
  "businessType": "AA",
  "threeDomainSecure": {
    "eci": "05",
    "ucaf": "jJJLtQa+Iws8AREAEbjsA1MAAAA=",
    "cavv": "8c5f2a1b9d3e4f60718293a4b5c6d7e8f9012345",
    "xid": "3f2b8c1e-7a4d-4e9b-9c6f-1d2e3a4b5c6d"
  }
}'

nodejs

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://sandbox.crbcos.com/cardpayments/v1/payments',
  'headers': {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json',
    'Accept': 'application/json'
  },
  body: JSON.stringify({
    "cardToken": "11FB445C487140A9BEA51457A796172A000000",
    "accountNumber": "2287979807",
    "amount": 1000,
    "paymentType": "Push",
    "correspondingEntity": {
      "firstName": "Prudence",
      "lastName": "Stracke",
      "externalAccountIdentifier": "12345678901234",
      "address": {
        "street1": "2866 Margie Burg",
        "street2": "",
        "city": "Lorishire",
        "state": "NY",
        "postalCode": "123456789",
        "countryCode": "US"
      }
    },
    "mcc": "9876",
    "cvv": "123",
    "clientIdentifier": "string",
    "businessType": "AA",
    "threeDomainSecure": {
      "eci": "05",
      "ucaf": "jJJLtQa+Iws8AREAEbjsA1MAAAA=",
      "cavv": "8c5f2a1b9d3e4f60718293a4b5c6d7e8f9012345",
      "xid": "3f2b8c1e-7a4d-4e9b-9c6f-1d2e3a4b5c6d"
    }
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

python

import requests
import json

url = "https://sandbox.crbcos.com/cardpayments/v1/payments"

payload = json.dumps({
  "cardToken": "11FB445C487140A9BEA51457A796172A000000",
  "accountNumber": "2287979807",
  "amount": 1000,
  "paymentType": "Push",
  "correspondingEntity": {
    "firstName": "Lyla",
    "lastName": "Abbott",
    "externalAccountIdentifier": "12345678901234",
    "address": {
      "street1": "39633 Bianka Fork",
      "street2": "",
      "city": "Kansas City",
      "state": "NY",
      "postalCode": "123456789",
      "countryCode": "US"
    }
  },
  "mcc": "9876",
  "cvv": "123",
  "clientIdentifier": "string",
  "businessType": "AA",
  "threeDomainSecure": {
    "eci": "05",
    "ucaf": "jJJLtQa+Iws8AREAEbjsA1MAAAA=",
    "cavv": "8c5f2a1b9d3e4f60718293a4b5c6d7e8f9012345",
    "xid": "3f2b8c1e-7a4d-4e9b-9c6f-1d2e3a4b5c6d"
  }
})
headers = {
  'Authorization': 'Bearer <token>',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://sandbox.crbcos.com/cardpayments/v1/payments")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request["Accept"] = "application/json"
request.body = JSON.dump({
  "cardToken": "11FB445C487140A9BEA51457A796172A000000",
  "accountNumber": "2287979807",
  "amount": 1000,
  "paymentType": "Push",
  "correspondingEntity": {
    "firstName": "Darwin",
    "lastName": "Reilly",
    "externalAccountIdentifier": "12345678901234",
    "address": {
      "street1": "83160 Hector Turnpike",
      "street2": "",
      "city": "Thousand Oaks",
      "state": "NY",
      "postalCode": "123456789",
      "countryCode": "US"
    }
  },
  "mcc": "9876",
  "cvv": "123",
  "clientIdentifier": "string",
  "businessType": "AA",
  "threeDomainSecure": {
    "eci": "05",
    "ucaf": "jJJLtQa+Iws8AREAEbjsA1MAAAA=",
    "cavv": "8c5f2a1b9d3e4f60718293a4b5c6d7e8f9012345",
    "xid": "3f2b8c1e-7a4d-4e9b-9c6f-1d2e3a4b5c6d"
  }
})

response = https.request(request)
puts response.read_body

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://sandbox.crbcos.com/cardpayments/v1/payments"
  method := "POST"

  payload := strings.NewReader(`{
  "cardToken": "11FB445C487140A9BEA51457A796172A000000",
  "accountNumber": "2287979807",
  "amount": 1000,
  "paymentType": "Push",
  "correspondingEntity": {
    "firstName": "Darrin",
    "lastName": "Considine",
    "externalAccountIdentifier": "12345678901234",
    "address": {
      "street1": "2436 Bradtke Mountains",
      "street2": "",
      "city": "Marysville",
      "state": "NY",
      "postalCode": "123456789",
      "countryCode": "US"
    }
 },
  "mcc": "9876",
  "cvv": "123",
  "clientIdentifier": "string",
  "businessType": "AA",
  "threeDomainSecure": {
    "eci": "05",
    "ucaf": "jJJLtQa+Iws8AREAEbjsA1MAAAA=",
    "cavv": "8c5f2a1b9d3e4f60718293a4b5c6d7e8f9012345",
    "xid": "3f2b8c1e-7a4d-4e9b-9c6f-1d2e3a4b5c6d"
  }
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Accept", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

200

{
    "id": "d706c741-e556-4101-a849-b42b00bfd7e9",
    "clientIdentifier": "string",
    "amount": 1000,
    "paymentType": "Push",
    "status": "Created",
    "source": "OpsPortal",
    "productId": "31cae717-408e-4813-a6b1-ad6600e48632",
    "partnerId": "82a1cfb9-de92-4cc2-8a74-ad6600e36d7a",
    "cardId": "26acd726-dade-4064-996a-b42b00b634df",
    "cardToken": "11FB445C487140A9BEA51457A796172A000000",
    "cardBrand": "Visa",
    "panLastFour": "1111",
    "issuerCountryCode": "US",
    "correspondingEntity": {
        "firstName": "Justina",
        "lastName": "Jacobs",
        "externalAccountIdentifier": "123456***1234",
        "address": {
            "street1": "511 Annalise Squares",
            "street2": "",
            "city": "Columbus",
            "state": "NY",
            "postalCode": "123456789",
            "countryCode": "US"
        }
    },
    "mcc": "9876",
    "merchantVerificationValue": "123456",
    "accountNumber": "2287979807",
    "businessType": "AA",
    "wasRefunded": false,
    "createdAt": "2026-04-13T07:38:28.8271201-04:00",
    "limitsEligibleOn": "2026-04-13T07:38:28.8271201-04:00",
    "lastModifiedAt": "2026-04-13T07:38:28.9388613-04:00"
}