GuidesAPI ReferenceSwagger
API Reference

Create a payment request

post
https://sandbox.avinode.com/payapi/paymentrequest
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum

Action to take (defaults to SAVE)

Allowed:
string
length ≤ 30

The TripId

string

The Avinode Group TripId

customerDetails
object
required

The customer for this payment request.

string
length ≤ 255
deprecated

The name of the customer. DEPRECATED - prefer customerDetails.displayName

int64
deprecated

The id of the customer company. DEPRECATED - prefer customerDetails.platformCompanyId

int64
deprecated

The id of the customer account. DEPRECATED - prefer customerDetails.platformAccountId

string
length ≤ 255

Email addresses to customer(s) where the payment request details will be sent. Leave empty if no notification should be sent

string
length ≤ 50

A (visual) reference

string
length ≤ 255

Technical reference how this PaymentRequest was created

externalIdentities
array of objects

The external identitie(s) for this payment request

externalIdentities
string
length ≤ 1000

A message to the customer. Do not send any value to get default message

string

The payout currency

lineItems
array of objects

The line items for all charges included

lineItems
boolean
legs
array of objects

The legs of the trip

legs
documents
object

The documents to use for this payment request.

Headers
string

ISO8601 Timestamp

string

API Token

string

Calling product / software (ex: AcmeApp-v10.2)

string

Account id if action on behalf of

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?