Payments API¶
Pay an invoice¶
POST /invoice/{invoiceLocator}/pay
Request:
Name
Position
Type
Required
invoiceLocator
path
string
required
paymentCreateRequest
body
optional
Response:
PaymentResponse2
Fetch a Payment¶
GET /payments/{paymentLocator}
Request:
Name
Position
Type
Required
paymentLocator
path
string
required
Response:
PaymentResponse2
PaymentResponse2¶
{// Requiredamount : numberamountCurrency : stringdisplayId : stringfieldValues : map<string,[string]>invoiceLocator : stringlocator : stringmediaByLocator : map<string,Media>postedTimestamp : timestamp// OptionalreversedTimestamp : timestamp}
Reverse a Payment¶
POST /payments/{paymentLocator}/reverse
Request:
Name
Position
Type
Required
paymentLocator
path
string
required
Response:
PaymentResponse2
When an endorsement or renewal has a paid invoice and is then invalidated, the payment for that invoice will automatically be reversed.