POST api/payment/charge
Request Information
URI Parameters
None.
Body Parameters
ChargeCreditCardRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ApplicationKey | string |
Required Max length: 100 |
|
| Payment | PaymentDto |
Required |
Request Formats
application/json, text/json
Sample:
{
"applicationKey": "sample string 1",
"payment": {
"id": 1,
"amount": 1.0,
"externalCustomerId": "sample string 2",
"creditCardId": 1,
"creditCard": {
"id": 1,
"customerId": 1,
"externalCustomerId": "sample string 1",
"isOrganization": true,
"firstName": "sample string 3",
"lastName": "sample string 4",
"company": "sample string 5",
"address": "sample string 6",
"city": "sample string 7",
"state": "sample string 8",
"zip": "sample string 9",
"country": "sample string 10",
"phoneNumber": "sample string 11",
"cardNumber": "XXXXXXXXXXXXg 12",
"expirationDate": "sample string 13",
"cardCode": "XXXXXXXXXXXXXXXX",
"cardType": "sample string 15"
},
"invoiceNumber": "sample string 3",
"invoiceDescription": "sample string 4",
"lineItems": [
{
"itemId": "sample string 1",
"name": "sample string 2",
"description": "sample string 3",
"quantity": 4.0,
"unitPrice": 5.0
},
{
"itemId": "sample string 1",
"name": "sample string 2",
"description": "sample string 3",
"quantity": 4.0,
"unitPrice": 5.0
}
],
"taxAmount": 1.0,
"taxName": "sample string 5",
"taxDescription": "sample string 6",
"dutyAmount": 1.0,
"dutyName": "sample string 7",
"dutyDescription": "sample string 8",
"cardCode": "XXXXXXXXXXXXXXX",
"paymentStatus": "Authorized",
"merchantApplicationId": 1,
"merchantApplicationName": "sample string 10",
"authorizedAmount": 1.0,
"capturedAmount": 1.0,
"refundedAmount": 1.0,
"customer": {
"id": 1,
"externalCustomerId": "sample string 1",
"merchantCustomerId": "sample string 2",
"merchantDescription": "sample string 3",
"email": "sample string 4",
"firstName": "sample string 5",
"lastName": "sample string 6",
"address": "sample string 7",
"city": "sample string 8",
"state": "sample string 9",
"zip": "sample string 10",
"country": "sample string 11",
"phoneNumber": "sample string 12"
},
"priceDiference": 1.0,
"customerIP": "sample string 11"
}
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.