REST API | American Express

Example: Sale

Request
{ "clientReferenceInformation": { "code": "482046C3A7E94F5BD1FE3C66C" }, "processingInformation": { "capture": true }, "paymentInformation": { "card": { "number": "4111111111111111", "expirationMonth": "12", "expirationYear": "2031", "type": "001", "securityCode": "999" <!-- Required only for
Visa Platform Connect
. --> "useAs": "DB", <!-- Required only for
China UnionPay
. --> "typeSelectionIndicator": "1" <!-- Required only for
China UnionPay
. --> } }, "orderInformation": { "amountDetails": { "totalAmount": "49.95", "currency": "USD" }, "lineItems": [ { "quantity": "1", "unitPrice": "49.95", "totalAmount": "49.94" } ], "billTo": { "firstName": "John", "lastName": "Doe", "address1": "1295 Charleston Rd.", "locality": "Mountain View", "administrativeArea": "CA", "postalCode": "94043", "country": "US", "email": "jdoe@example.com", "phoneNumber": "650-965-6000" } } }
Response
Most processors do not return all of the fields in this example.
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/payments/030578265000016790508/voids" }, "self": { "method": "GET", "href": "/pts/v2/payments/030578265000016790508" } }, "clientReferenceInformation": { "code": "482046C3A7E94F5BD1FE3C66C" }, "id": "030578265000016790508", "orderInformation": { "amountDetails": { "totalAmount": "49.95", "authorizedAmount": "49.95", "currency": "USD" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "card": { "type": "001" }, "accountFeatures": { "category": "CN", "group": "0" } }, "processingInformation": { "reconciliationId": "02850840187309570" }, "processorInformation": { "approvalCode": "123456", "networkTransactionId": "3312345", "transactionId": "123456789619999", "responseCode": "A", "avs": { "code": "Y", "codeRaw": "YYY" } }, "reconciliationId": "ABCDE12345FGHIJ67890", "status": "AUTHORIZED", "submitTimeUtc": "2021-07-30T15:07:53Z" }