Introduction

Corpay Cross-Border API Documentation v1.8

Corpay Cross-Border API uses HATEOAS (Hypertext As The Engine Of Application State) framework. This means every response not only provides the requested data but also includes relevant links. This provides a link on the current resource as well as all actions that can be taken from there.

Response to APIs, once authenticated, are displayed in the following model, where content and errors are provided in the appropriate lists. Links always contain a SELF link to the current endpoint, and any additional links, depending on the state of the resource. For example, a beneficiary object can be viewed and modified.

 
  {
    "content": {},
    "errors": [],
    "links": [
        {
            "rel": "self",
            "uri":   "https://crossborder.corpay.com/api/{{endpoint}}",
            "method": {POST GET or PUT}
        }
    ]
  }