Skip to main content

Link API (1.0.0)

Download OpenAPI specification:Download

Auth

Flow

  • All API calls require an Authorization: Bearer <bearer token> header.
  • Automated <bearer token> rotation is recommended.
  • Successful authentication rotation calls will return a new bearer token.

Request or refresh an authorization token

Request or refresh an authorization token

header Parameters
User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

Request-ID
required
string

The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.

Request Body schema: application/json
grantType
required
string

Grant type

code
required
string

Authorization code to generate access and refresh token. Make sure to use the authorization code provided.

Responses

Request samples

Content type
application/json
Example
{
  • "grantType": "authorization_code",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "hsfsdgfdsgvb4354gfnbnkaerAtrJKNnrtusiJNOuts",
  • "expiration": "2023-02-18T19:39:39.548608815Z",
  • "refreshToken": "sflk5j6q2kgmKjfrs_kijdngka9qpoutrei45gfnm",
  • "tokenType": "Bearer"
}

Secondary Market Flow

MyAccount Seller Flow

MyAccount Seller Flow

Barcode (Indy) Seller Flow

Indy Seller Flow

Buyer Flow

Buyer Flow

Messaging Service

A messaging service to push event and seat changes in real-time.

Flow

Paciolan's internal systems will publish messages to Amazon SNS when changes occur to events or seats, which will then be consumed by its subscribers.

Request an event message

Request an event message

header Parameters
Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

Request Body schema: application/json
required
object (eventData)

Request data

required
Array of objects

Collection of events with changes

Array
accessId
required
string

Main/Parking event accessId

seasonCode
required
string

Season code

itemCode
required
string

Item code

itemBasis
string

Item basis

itemName
required
string

Item name

  • Precedence: 1
  • Internet Name 2
  • Item Name 3.
  • Event name
startDate
required
string <date> (startDate)

Date part (before "T" delimiter) of ISO 8601 compliant date.

required
string or string (startTime)
endDate
required
string or null <date> (endDate)

Date part (before "T" delimiter) of ISO 8601 compliant date.

required
(string or null) or (string or null) (endTime)
facilityCode
required
string

Facility code

facilityName
required
string

Facility Name

required
object
messageEntity
required
string
Value: "events"

The name of the entity pushing the changes

pacOrganizationId
required
number

The client's data account ID

requestId
required
string

A unique ID provided for debugging purposes

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{ }

Request a seat message

Request a seat message

header Parameters
Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

Request Body schema: application/json
required
object (seatData)

Request data

required
Array of objects

Collection of seats with changes

Array
accessId
required
string

The accessId for the event the seat is located in, which will always be the main/home or parking event.

season
required
string

Season code

item
required
string

Item code

section
required
string

Section code. (LEVEL:SECTION)

row
required
string

Row

startDate
string

Seat

status
required
string
Enum: "LOCK" "UNLOCK"

Seat status. e.g. Active listings need to be removed from integrator's site if the message received for such listed ticket receives a status of UNLOCK

required
object
messageEntity
required
string
Value: "seats"

The name of the entity pushing the changes

pacOrganizationId
required
number

The client's data account ID

requestId
required
string

A unique ID provided for debugging purposes

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{ }

Catalog Service

Get catalog events

The events endpoint returns a list of items available for secondary.

query Parameters
startDate
string <date>
Example: startDate=2023-05-20

Date in the format of YYYY-MM-DD. Applicable to events only. When specified, only those event items with a start date on or after this date will be returned.

seasonCode
string

A (single) season code may be specified to filter output.

facilityCode
string

A (single) facility code may be specified to filter output.

header Parameters
User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

Request-ID
required
string

The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.

PAC-Organization-ID
required
string
Example: 999

The client's data account ID to pull events from.

Responses

Request samples

curl 'https://link-sandbox.paciolan.info/v1/catalog/events' \
  -H 'User-Agent: MyApplication/1.0' \
  -H 'Authorization: Bearer <BearerToken>'
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'PAC-Application-ID: com.mycompany.myapp' \
  -H 'PAC-API-Key: <ApiKey>' \
  -H 'PAC-Channel-Code: my-application' \
  -H 'Request-ID: <RequestID>' \
  -H 'PAC-Organization-ID: 999'

Response samples

Content type
application/json
[
  • {
    }
]

Listing Service

Get listing

The Get Listings API endpoint will return seats (as tokens) grouped by event accessId for the given listingId provided.

Flow

  • A patron on MyAccount will select items/seats (from any event) that they want to list for resale.
  • The Paciolan system will then generate and append a listingId identifier to the integrator's website when navigating the user over.
  • Integrator will then make an API call to this Get Listings API with the listingId to receive tokens for each item/seat selected by the patron.
path Parameters
listingId
required
string
Example: A3qnemZ

Listing ID.

header Parameters
User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

Request-ID
required
string

The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.

Responses

Request samples

curl 'https://link-sandbox.paciolan.info/v1/listings/A3qnemZ' \
  -H 'User-Agent: MyApplication/1.0' \
  -H 'Authorization: Bearer <BearerToken>'
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'PAC-Application-ID: com.mycompany.myapp' \
  -H 'PAC-API-Key: <ApiKey>' \
  -H 'PAC-Channel-Code: my-application' \
  -H 'Request-ID: <RequestID>'

Response samples

Content type
application/json
[
  • {
    }
]

Ticket Service

Lock

The Lock API will lock the tokens provided to prevent any status changes to them.

Flow

While the listing is being created, there will be a request to API to lock the inventory. (Means protected)

header Parameters
User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

Request-ID
required
string

The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.

Request Body schema: application/json
One of
source
required
string
Enum: "INDIVIDUAL" "BROKER"

Source

required
object (lock-listing)
externalListingId
string

External Listing ID

totalPrice
number

Listing Price

required
Array of objects (lock-token)

Array of Tokens and Price

Array
token
required
string

Token

individualPrice
number

Individual price of a ticket

required
object (lock-seller)
lastName
required
string

Account last name.

firstName
required
string

Account first name.

middleName
string

Account middle name.

Array of objects (lock-seller-address)

Object which contains address information.

Array
address1
required
string

This represents street number & street name.

address2
string

This represents suite number. This value can be null.

address3
string

This value could be null.

address4
string

This value could be null.

locality
required
string

This represents the city.

region
required
string

This represents the state/province.

postalCode
required
string

This represents the postalCode.

countryCode
required
string

This represents the country code.

Array of objects (lock-seller-phoneNumber)

This represents patron's phone number

Array
number
required
string

Patron phone number, unformatted, with all non-numeric characters removed. This field is required if phone number is required

formattedNumber
string

Patron phone number formatted

extension
string

This. could be null. Required if the phone number is required

countryCode
required
string

Patron phone number country code. This is required if the phone number is required

required
Array of objects (lock-seller-emailAddress)

Object which contains patron email information.

Array
email
required
string

Patron email address

optIn
boolean

Patron marketing opt-in. If true, and if new patron is created, the API will set the email marketing flag to true. If the request resolves to existing patron then we WILL NOT update the email marketing flag for existing patrons.

Responses

Request samples

Content type
application/json
{
  • "source": "MY_ACCOUNT",
  • "listing": {
    },
  • "seller": {
    }
}

Response samples

Content type
application/json
{
  • "sellerIds": [
    ],
  • "success": [
    ]
}

Unlock

The Unlock API will unlock tokens provided which will open that item/seat for status changes. This API is idempotent. All it does is unlock the inventory. (Flipping the mpreserve flag to false)

Flow

If the seller decides to unlist their items/seats (for any reason), then a request to unlock those tokens is needed.

header Parameters
User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

Request-ID
required
string

The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.

Request Body schema: application/json
tokens
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "tokens": [
    ]
}

Response samples

Content type
application/json
{
  • "success": [
    ]
}

Complete Order

The Complete Order API endpoint commits a cart to a sale and records a financial transaction.

header Parameters
User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

Request-ID
required
string

The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.

Request Body schema: application/json
required
Array of objects (completeOrder-body-listing)

Listing Info

Array
externalListingId
required
string

External Listing ID

externalOrderId
required
string

External Order ID

totalPrice
number

Total listing price (exclude fees)

totalFees
number

Total fees

required
Array of objects

Array of Objects Represents individual tickets with a token and price.

required
Array of objects (completeOrder-body-buyer)

Buyer Information

Array
firstName
required
string

Buyer's first name.

middleInitial
string

Buyer's middle initial.

lastName
required
string

Buyer's last name.

required
object (completeOrder-body-buyer-phoneNumber)
object (completeOrder-body-buyer-address)
required
object (completeOrder-body-buyer-emailAddress)
required
Array of objects (completeOrder-body-settlement)

Required for resale.

Array
totalAmountPaid
required
number

Total amount paid by the buyer(includes fees).

amountToSeller
required
number

Amount paid to the seller.

asyncCallbackUrl
string

If the complete order call takes longer than expected, we will respond back with a status of "PENDING". If this callback URL is provided, our systems will then call it when the status updates, setting the request of the call to follow the response object definition below.

Responses

Request samples

Content type
application/json
{
  • "listing": [
    ],
  • "buyer": [
    ],
  • "settlement": [
    ]
}

Response samples

Content type
application/json
Example
{}

Get complete order status

The Complete Order Status API endpoint returns the state of an order as received by the /cart/complete-order call. This endpoint is needed when the response to the /cart/complete-order has a status of PENDING, and no asyncCallbackUrl was provided for the system to inform the caller of a status change. Calling this endpoint will provide an update.

path Parameters
processId
required
string
Example: d4e5f6

Proccess ID.

header Parameters
User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

Request-ID
required
string

The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.

Responses

Request samples

curl 'https://link-sandbox.paciolan.info/v1/cart/complete-order/123456' \
  -H 'User-Agent: MyApplication/1.0' \
  -H 'Authorization: Bearer <BearerToken>'
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'PAC-Application-ID: com.mycompany.myapp' \
  -H 'PAC-API-Key: <ApiKey>' \
  -H 'PAC-Channel-Code: my-application' \
  -H 'Request-ID: <RequestID>'

Response samples

Content type
application/json
{
  • "processId": "d4e5f6",
  • "status": "PENDING"
}

Verify

This call will return ticket details for a group of barcode/tokens that were successfully verified as valid.

Flow

  • The tokens and/or barcodes are submitted, the request will reach to API.
  • The API will validate each token and barcode by calling the DB or miscroservices.
  • Once all the tickets are validated, the API will return the tickets' info + validate code.

Assumptions

For each and every token integrator will make a call to API to fetch the ticket validity.

header Parameters
User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

Request-ID
required
string

The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.

Request Body schema: application/json
required
Array of objects or objects

Array of objects which holds Tokens, Barcodes & AccessId

Array
One of
accessId
required
string

The event Id (representing the access dataaccount) for the corresponding token

tokens
required
Array of strings

Array of Tokens (must not be present if barcodes are present)

Responses

Request samples

Content type
application/json
{
  • "tickets": [
    ]
}

Response samples

Content type
application/json
{
  • "tokens": [
    ]
}

Print

The Print API can be used first time to retrieve the ticket.

Flow

After a successful cart checkout, this API will enable the 3rd party vendor to retrieve the digital tickets

Validations

If request payload contains tokens belonging to more than 1 organization ID then we reject as BAD_REQUEST

header Parameters
User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

Request-ID
required
string

The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.

Request Body schema: application/json
externalOrderId
required
string

External Order ID

tokens
required
Array of strings

Array of Tokens

Responses

Request samples

Content type
application/json
{
  • "externalOrderId": "123456",
  • "tokens": [
    ]
}

Response samples

Content type
application/json
{}

Ticket

Initiate Transfer

This call will create a transfer ticket request that can be accepted or cancel later.

query Parameters
distributorCode
string
Example: distributorCode=AMTX

Distributor code. Required if initiating transfer with seat details.

header Parameters
User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

Request-ID
required
string

The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.

PAC-Organization-ID
required
string
Example: 999

The client's data account ID to pull events from.

Request Body schema: application/json
linkId
string

Link ID

siteId
string

Site ID

baseUrl
string

Base URL for acceptance

required
Array of Seats (object) or Items (object)

Array of Objects

Array
Any of
required
object

Recipient details

required
Array of objects

Seat details for transfers. Required if calling without "Items" array.

required
object

Sender details

Responses

Request samples

Content type
application/json
{
  • "linkId": "string",
  • "siteId": "string",
  • "baseUrl": "string",
  • "transferRequests": [
    ]
}

Response samples

Content type
application/json
{}

Cancel Transfer

This call will cancel the transfer.

path Parameters
confirmationCd
required
string
Example: 3785222-AMTX:10555

Confirmation CD

header Parameters
User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

Request-ID
required
string

The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.

PAC-Organization-ID
required
string
Example: 999

The client's data account ID to pull events from.

Responses

Request samples

curl --location --request DELETE 'http://api-orch-qfnq.eks.paciolan.info/v1/tickets/transfer/3785222-AMTX:10555' \
  --header 'User-Agent: MyApplication/1.0' \
  --header 'Authorization: Bearer <BearerToken>' \
  --header 'PAC-Channel-Code: my-application' \
  --header 'PAC-Application-ID: com.mycompany.myapp' \
  --header 'PAC-API-Key: <ApiKey>' \
  --header 'Request-ID: <RequestID>' \
  --header 'PAC-Organization-ID: 999' \
  --header 'Content-Type: application/json'

Response samples

Content type
application/json
{
  • "patronId": "3785222",
  • "confirmationCd": "3785222-AMTX:10270",
  • "cancelDt": "06/15/2023 09:43:12",
  • "transferStatus": "Cancelled"
}

Transfer History

This call will return transfer history.

path Parameters
confirmationCd
required
string
Example: 3785222-AMTX:10555

Confirmation CD

header Parameters
User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

Request-ID
required
string

The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.

PAC-Organization-ID
required
string
Example: 999

The client's data account ID to pull events from.

Responses

Request samples

curl --location 'http://api-orch-qfnq.eks.paciolan.info/v1/tickets/transfer/3785222-AMTX:10555' \
  --header 'User-Agent: MyApplication/1.0' \
  --header 'Authorization: Bearer <BearerToken>' \
  --header 'PAC-Channel-Code: my-application' \
  --header 'PAC-Application-ID: com.mycompany.myapp' \
  --header 'PAC-API-Key: <ApiKey>' \
  --header 'Request-ID: <RequestID>' \
  --header 'Content-Type: application/json'

Response samples

Content type
application/json
{
  • "transferId": "3785222-AMTX:10237",
  • "recipientFirstName": "Juan",
  • "recipientLastName": "Ramirez",
  • "history": [
    ],
  • "createTs": "2023-06-14T07:23:05.281+0000"
}

Accept Transfer

This call will accept a pending transfer request to the recipent user.

query Parameters
distributorCode
string
Example: distributorCode=AMTX

Distributor code. Required if initiated transfer with seat details.

header Parameters
User-Agent
required
string

An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application.

Authorization
required
string
Example: Basic dGVzdDp0ZXN0

Authorization with Basic Auth

Accept
required
string
Default: application/json

The only supported response type for this endpoint is application/json.

Accept-Encoding
string

gzip compression is supported.

Content-Type
required
string
Default: application/json

The only supported request type for this endpoint is application/json.

PAC-Application-ID
required
string

The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning.

PAC-API-Key
required
string

The API key provided by Paciolan for this application.

PAC-Channel-Code
required
string

The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding.

Request-ID
required
string

The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value.

Request Body schema: application/json
transferId
required
string

Transfer ID

object

Recipient details

phone
string

Recipient phone

email
required
string

Recipient email

recipientFirstName
required
string

Recipient first name. Required when calling after initiating transfer with tokens.

recipientLastName
required
string

Recipient last name. Required when calling after initiating transfer with tokens.

Responses

Request samples

Content type
application/json
{
  • "transferId": "string",
  • "Recipient": {
    }
}

Response samples

Content type
application/json
{
  • "confirmationCd": "3785222-AMTX:10237",
  • "transferId": "w53hKM1ZPmDBgYsq68VW6xR6KLLeoWCR"
}