Sync Payment

API reference

Send a push or pull sync payment

Endpoint: /v1/syncpayments

POST

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

Body Parameters

paymentIdstring
cardIdstring
Description
A UUID that identifies the card used. 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 account number associated with the payment
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
- firstNamestringrequired
  Description
  First name. Min 1 character, max 35 characters
- lastNamestringrequired
  Description
  Last name. Min 1 character, max 35 characters
- externalAccountIdentifierstringrequired
  Description
  Account number to ensure the money movement is routed to the correct destination.
- addressobject
  Description
  Address of card holder
  - street1stringrequired
    Description
    Street address line 1. Max length 60
  - street2string
    Description
    Street address line 2. Max length 60
  - citystringrequired
    Description
    Name of the city. Max length 60
  - statestring
    Description
    State code. 2 characters
  - postalCodestringrequired
    Description
    Max 10 characters
  - 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.
initiatorNamestring
Description
Per-payment merchant/sender name override for the cardholder's bank statement. Max 17 chars
cvvstring
Description
Card Verification Value, a 3 or 4 digit security code printed on your debit card
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', BI - 'Money transfer (bank-initiated)', CD - 'Cash Deposit', FT - 'Funds Transfer', WT - 'Wallet Transfer', CP - 'Card Bill Payment' MD - 'Merchant Disbursement'
purposeOfPaymentstring
Description
The reason for the transaction. e.g. payroll. Needed for international.
threeDomainSecureobject
Description
3-D Secure (3DS) authentication values from your 3DS provider. The values must follow the card brand rules in the fields below; a request that breaks them can fail with error 2111.
- ecistring
  Description
  Electronic Commerce Indicator (ECI) from the 3DS authentication. One of 00, 01, 02, 05, 06, 07. Visa: 05, 06 or 07. Mastercard: 00, 01 or 02. If you don't send it, COS uses 07 (00 for Mastercard).
- cavvstring
  Description
  Visa authentication value (CAVV). A hexadecimal string of exactly 40 characters. Required for Visa when eci is 05 or 06.
- ucafstring
  Description
  Mastercard authentication value (UCAF). Maximum 32 characters. Required for Mastercard when eci is 01 or 02.
- xidstring
  Description
  3DS transaction identifier (XID). Exactly 36 characters.

Response

idstring
Description
The GUID of the payment you want to retrieve
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)
sourcestring
Description
How the payment was initiated e.g. API
statusstring
Description
One of "Created", "Pending", "Authorized", "Submitted", "Processing", "Completed", "Rejected", "Failed"
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
Description
A randomly generated string of characters that relates to the consumer's payment card (15-38 alphanumeric characters)
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
Description
References information about who initiated the transaction, linking to an OriginatorInfo object.
- firstNamestring
- lastNamestring
- externalAccountIdentifierstring
- addressobject
  - street1string
    Description
    street1
  - street2string
  - citystring
  - statestring
  - postalCodestring
  - countryCodestring
mccstring
Description
Merchant Category Code (MCC). 4-digits that a credit card issuer uses to categorize consumer transactions for their card.
initiatorNamestring
Description
Per-payment merchant/sender name override for the cardholder's bank statement. Max 17 chars
merchantVerificationValuestring
Description
A value used to verify the merchant's identity.
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', BI - 'Money transfer (bank-initiated)', CD - 'Cash Deposit', FT - 'Funds Transfer', WT - 'Wallet Transfer', CP - 'Card Bill Payment' MD - 'Merchant Disbursement'
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. Null if it wasn't sent.
threeDomainSecureUcafstring
Description
The 3DS UCAF value sent in threeDomainSecure.ucaf. Null if it wasn't sent.
threeDomainSecureCavvstring
Description
The 3DS CAVV value sent in threeDomainSecure.cavv. Null if it wasn't sent.
threeDomainSecureXidstring
Description
The 3DS XID value sent in threeDomainSecure.xid. Null if it wasn't sent.

curl

curl --location 'https://sandbox.crbcos.com/cardpayments/v1/syncpayments' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
    "cardToken": "11FB445C487140A9BEA51457A796172A000000",
    "accountNumber": "98752973255888149",
    "amount": 99999999999999,
    "paymentType": "Push",
    "correspondingEntity": {
        "firstName": "John",
        "lastName": "Johnsom",
        "externalAccountIdentifier": "njkKPji4hDx16ZvUqEB",
        "address": {
            "street1": "S?treet1",
            "street2": "Street2",
            "city": "New York",
            "state": "NY",
            "postalCode": "10128",
            "countryCode": "US"
        }
    },
    "mcc": "1234",
    "cvv": "0917",
    "clientIdentifier": "dkdkdkddkdkdkkd",
    "businessType": "BB",
    "purposeOfPayment": "ISACCT",
    "paymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "threeDomainSecure": {
        "eci": "05",
        "cavv": "8c5f2a1b9d3e4f60718293a4b5c6d7e8f9012345",
        "xid": "3f2b8c1e-7a4d-4e9b-9c6f-1d2e3a4b5c6d"
    }
}'

nodejs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': 'sandbox.crbcos.com',
  'path': '/cardpayments/v1/syncpayments',
  'headers': {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json',
    'Accept': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "cardToken": "11FB445C487140A9BEA51457A796172A000000",
  "accountNumber": "98752973255888149",
  "amount": 99999999999999,
  "paymentType": "Push",
  "correspondingEntity": {
    "firstName": "John",
    "lastName": "Johnsom",
    "externalAccountIdentifier": "njkKPji4hDx16ZvUqEB",
    "address": {
      "street1": "S?treet1",
      "street2": "Street2",
      "city": "New York",
      "state": "NY",
      "postalCode": "10128",
      "countryCode": "US"
    }
  },
  "mcc": "1234",
  "cvv": "0917",
  "clientIdentifier": "dkdkdkddkdkdkkd",
  "businessType": "BB",
  "purposeOfPayment": "ISACCT",
  "paymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "threeDomainSecure": {
    "eci": "05",
    "cavv": "8c5f2a1b9d3e4f60718293a4b5c6d7e8f9012345",
    "xid": "3f2b8c1e-7a4d-4e9b-9c6f-1d2e3a4b5c6d"
  }
});

req.write(postData);

req.end();

python

import requests
import json

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

payload = json.dumps({
  "cardToken": "11FB445C487140A9BEA51457A796172A000000",
  "accountNumber": "98752973255888149",
  "amount": 99999999999999,
  "paymentType": "Push",
  "correspondingEntity": {
    "firstName": "John",
    "lastName": "Johnsom",
    "externalAccountIdentifier": "njkKPji4hDx16ZvUqEB",
    "address": {
      "street1": "S?treet1",
      "street2": "Street2",
      "city": "New York",
      "state": "NY",
      "postalCode": "10128",
      "countryCode": "US"
    }
  },
  "mcc": "1234",
  "cvv": "0917",
  "clientIdentifier": "dkdkdkddkdkdkkd",
  "businessType": "BB",
  "purposeOfPayment": "ISACCT",
  "paymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "threeDomainSecure": {
    "eci": "05",
    "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/syncpayments")

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": "98752973255888149",
  "amount": 99999999999999,
  "paymentType": "Push",
  "correspondingEntity": {
    "firstName": "John",
    "lastName": "Johnsom",
    "externalAccountIdentifier": "njkKPji4hDx16ZvUqEB",
    "address": {
      "street1": "S?treet1",
      "street2": "Street2",
      "city": "New York",
      "state": "NY",
      "postalCode": "10128",
      "countryCode": "US"
    }
  },
  "mcc": "1234",
  "cvv": "0917",
  "clientIdentifier": "dkdkdkddkdkdkkd",
  "businessType": "BB",
  "purposeOfPayment": "ISACCT",
  "paymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "threeDomainSecure": {
    "eci": "05",
    "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/syncpayments"
  method := "POST"

  payload := strings.NewReader(`{
    "cardToken": "11FB445C487140A9BEA51457A796172A000000",
    "accountNumber": "98752973255888149",
    "amount": 99999999999999,
    "paymentType": "Push",
    "correspondingEntity": {
        "firstName": "John",
        "lastName": "Johnsom",
        "externalAccountIdentifier": "njkKPji4hDx16ZvUqEB",
        "address": {
            "street1": "S?treet1",
            "street2": "Street2",
            "city": "New York",
            "state": "NY",
            "postalCode": "10128",
            "countryCode": "US"
        }
    },
    "mcc": "1234",
    "cvv": "0917",
    "clientIdentifier": "dkdkdkddkdkdkkd",
    "businessType": "BB",
    "purposeOfPayment": "ISACCT",
    "paymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "threeDomainSecure": {
        "eci": "05",
        "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": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "originalPaymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "clientIdentifier": "dkdkdkddkdkdkkd",
    "amount": 0,
    "paymentType": "Push",
    "status": "Created",
    "source": "Api",
    "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "partnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cardToken": "11FB445C487140A9BEA51457A796172A000000",
    "network": "string",
    "rail": "string",
    "cardBrand": "AmericanExpress",
    "panLastFour": "string",
    "issuerCountryCode": "string",
    "retrievalReferenceId": "string",
    "networkTransactionId": "string",
    "reasonCode": "string",
    "reasonDescription": "string",
    "traceNumber": "string",
    "correspondingEntity": {
        "firstName": "string",
        "lastName": "string",
        "externalAccountIdentifier": "6h9tKToLnBJYJotBs83",
        "address": {
            "street1": "string",
            "street2": "string",
            "city": "string",
            "state": "st",
            "postalCode": "string",
            "countryCode": "string"
        }
    },
    "mcc": "string",
    "merchantVerificationValue": "string",
    "accountNumber": "string",
    "businessType": "BB",
    "purposeOfPayment": "ISACCT",
    "coreTransactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "memoPostId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "memoPostRemovedAt": "2026-06-07T07:04:31.973Z",
    "wasRefunded": true,
    "refundPaymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdAt": "2026-06-07T07:04:31.973Z",
    "authorizedOn": "2026-06-07T07:04:31.973Z",
    "submittedOn": "2026-06-07T07:04:31.973Z",
    "rejectedAt": "2026-06-07T07:04:31.973Z",
    "completedAt": "2026-06-07T07:04:31.973Z",
    "failedAt": "2026-06-07T07:04:31.973Z",
    "limitsEligibleOn": "2026-06-07T07:04:31.973Z",
    "lastModifiedAt": "2026-06-07T07:04:31.973Z",
    "threeDomainSecureEci": "05",
    "threeDomainSecureUcaf": null,
    "threeDomainSecureCavv": "8c5f2a1b9d3e4f60718293a4b5c6d7e8f9012345",
    "threeDomainSecureXid": "3f2b8c1e-7a4d-4e9b-9c6f-1d2e3a4b5c6d"
}