Release Notes: January 18th, 2022

An update was released to the CoreBridge API. Following are release notes related to new endpoints, changes to existing endpoints, and bug fixes. If you have questions, please contact our support department for assistance through our support site here or by emailing support@corebridge.net.  



ExOrder/CreateGenericOrder 

Updated to include an optional section for specifying Order Payments. 


Notes: 

  • This section is optional.
  • You can submit multiple unique payments on a single order.
  • No validation is in place to prevent payment amount > order total.


Sample JSON Request:


"OrderPayments": [
    {
      "PaymentType": "OfflineCC",
      "Notes": "My Payment Note",
      "CreditCardType": "Visa",
      "CreditCardLastFourDigits": "4789",
      "Amount": 22.33
    }
  ]


Parameter

Required

Type

Validation

ExternalOrderId

 

 

Ignored

CbOrderId

 

 

Ignored

PaymentType

Y

String

Valid Names:

  • ACH

  • Cash

  • Check

  • Wire

  • Other

  • OfflineCC

CustomPaymentType

S

String

Required if PaymentType = "Other"

Valid Names:

See Custom Payment Types in the UI.  Name must match exactly.

Notes

 

String

 

Location

 

 

Ignored

CreatedDate

 

 

Ignored

CreditCardName

 

 

Should be Ignored.  Currently if PaymentType = "OfflineCC", then it will get written to Transaction.TransactionData2

CreditCardType

S

 

This should be required if PaymentType = 'offlineCC” and should be a valid entry.  User should get an error otherwise and order not created.

Required if PaymentType = 'offlineCC”

Valid Names:

  • Visa

  • Mastercard

  • Discover

  • AMEX

CreditCardLastFourDigits

 

 

Only used if PaymentType = “offlineCC” 

writes to dbo.Transaction.TransactionData1

CreditCardExpirationYear

 

 

Ignored

CreditCardExpirationMonth

 

 

Ignored

CreditCardCVC

 

 

Ignored

CreditCardCVV2

 

 

Ignored

CheckNumber

 

 

Only used if PaymentType = “Check”

CheckIDNumber

 

 

Only used if PaymentType = “Check”

TransactionData1

 

 

Ignored

TransactionData2

 

 

Ignored

Amount

Y

 

 Should not allow negative number,   should not allow $0.