Retrieve the Payment Provider ID
How to retrieve a listing's payment provider ID.
Get the payment provider information for the listing being booked from the listing itself.
Available Endpoints
Method | Endpoint |
---|---|
GET | /payment-providers/provider-by-listing |
Key Parameters
Query Parameter | Type | Description | Required |
---|---|---|---|
listingId | string | The property's object ID. | ✔️ |
Example
Request
curl --location --globoff 'https://open-api.guesty.com/v1/payment-providers/provider-by-listing?listingId={listingId}'
Response
{
"_id": "6375259327a35b441f8ab6fa",
"paymentProcessorKey": "GUESTY_PAYMENTS",
"status": "ACTIVE",
"lastPendingPaymentDate": null,
"pendingPaymentsCount": 0,
"paymentMethodsCount": 12,
"accountId": "6fbef2d2d36c48b94f2c57bc",
"serviceProviderAccountId": 1234,
"serviceProviderSubAccountId": 1,
"serviceProviderProcessor": "nmi",
"providerType": "amaryllis",
"accountName": "Tropical Hideaway",
"defaultCurrency": "USD",
"isDefault": true,
"country": "US",
"apiKey": "713da96a24e41bb93f36e92cbcad1a3c",
"connectedAt": "2023-03-23T04:04:37.551Z",
"syncedAt": "2023-03-23T04:04:37.551Z",
"statsLastUpdated": "2023-06-05T07:02:35.156Z",
"paymentProcessorName": "GuestyPay",
"paymentProviderId": "689e9c9232bad3f435482fb3",
"fallbackToDefault": false
}
The paymentProviderId
field contains the required ID for the tokenization request.
Updated 4 months ago