REST Components

The path to the resource (object) to be acted upon. The ID of the resource must be provided in the path.

For example, the following resource path identifies a specific transaction (resource) in our database:

The main part of the resource path begins after the host, apitest.cybersource.com.

/pts/v2/payments

is the address (resource) on the CyberSource end that processes transaction detail requests. CyberSource returns a request ID that provides transaction details you can use for follow-up transactions, queries, or reference.

The verb defines the action to take regarding the resource:

Available verbs:

These verbs are referred to as

CRUD

operations. They allow the

C

reation,

R

etrieval,

U

pdate and

D

eletion of resources.

A POST or PUT request has a body. A GET request has no body. REST uses JSON (JavaScript Object Notation) as its content format. To help with the structure of your requests, you can generate sample CyberSource JSON request messages using the API Reference docs in the CyberSource Developer Center.

The header is a collection of fields and their associated values that provides information about the message to the receiver. Think of it as metadata about the message. The header also contains authentication information that tells CyberSource that the message is legitimate.