This API will be used for integration with B2B applications like SFDC. It will be used to compute the refund charges along with the method of payment to be used for the membership cancellation and downgrades.
Checkout
POST /v2/b2b/orders/checkout/charges
Body:
A Checkout Input JSON Object
Response:
The charges to be refunded along with the refund payment details.
Checkout JSON Objects
Checkout Input JSON Object
Field | Description | Notes |
|---|---|---|
| contactEmail | Email address of the customer. | Required |
| phoneNumber | Phone number of the customer. | |
| contactFirstName | First name of the customer. | Required |
| contactLastName | Last name of the customer. | Required |
| address1 | ||
| address2 | ||
| city | ||
| state | ||
| country | ||
| zipCode | Zip code of the customer. | |
| ccLastFourDigits | Last four digits of the credit card | Required |
| creditCardBrand | Type of credit card. One of Visa, MasterCard, AmericanExpress, Discover or Jcb | Required |
| manualEntryCardNumber | The credit card number as a string | |
| cvc | The credit card cvc number as a string | Required |
| expDate | MMyy format of the expiration date of the credit card | Required |
| paymentId | Id of the payment such as Check # or Voucher # | |
| notes | Notes about the order | |
| billingFirstName | ||
| billingLastName | ||
| billingEmail | ||
| billingPhoneNumber | ||
| billingAddress1 | ||
| billingAddress2 | ||
| billingCountry | ||
| billingCity | ||
| billingZipCode | ||
| billingState | ||
| memberships | ||
| memberships[x].itemType | Type of membership operation such as MembershipPurchase | Required for membership |
| memberships[x].membershipInfo | MembershipInfo Object |
REQUEST For membership purchase:
POST https://sand10-api.acmeticketing.net/v2/b2b/orders/checkout/charges
Sample Request
{ "contactFirstName" : "contactFirstName", "contactLastName" : "contactLastName", "address1" : "contact address 1", "address2" : "contact address 2", "country" : "contact country", "city" : "contact city", "state" : "contact state", "zipCode" : "95148", "phoneNumber" : "408-222-2345", "contactEmail" : "john@acme.com", "notes" : "notes", "billingFirstName" : "billingFirstName", "billingLastName" : "billingLastName", "billingEmail" : "doe@acme.com", "billingPhoneNumber" : "408-222-2345", "billingAddress1" : "billing address 1", "billingAddress2" : "billing address 2", "billingCountry" : "billing country", "billingCity" : "billing city", "billingZipCode" : "billing zip code", "billingState" : "billing state", "memberships" : [ { "itemType" : "MembershipCancel", "membershipInfo" : { "membershipId" : "57742a012095d87d690c39bc", } } ]} |
RESPONSE:
Response for the above request
{ "netAmount" : "-100.00", "paymentAmount" : "0.00", "refundAmount" : "100.00", "refundDetails" : [ { "refundAmount" : "100.00", "paymentMethod" : "CreditCard", "ccLastFourDigits" : "4242" } ]} |