The Payment Gateway Account object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

payment_gateway string required
is_default boolean

Default: false

payment_account string required
currency string
message string

Default: Please click on the link below to make your payment

payment_channel string

Default: Email

company string required
The Payment Gateway Account object 
{
  "id": "payment-gateway-account_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "payment_gateway": "payment_gateway_example",
  "is_default": false,
  "payment_account": "payment_account_example",
  "currency": "USD",
  "message": "Please click on the link below to make your payment",
  "payment_channel": "Email",
  "company": "Example Corp"
}
GET /api/accounts/payment-gateway-account/{id}

Retrieve a payment gateway account

Retrieves the details of an existing payment gateway account. Supply the unique payment gateway account ID that was returned from a previous request.

Path parameters

id string required

The identifier of the payment gateway account to retrieve.

Returns

Returns the payment gateway account object if a valid identifier was provided.

GET /api/accounts/payment-gateway-account/{id} 
curl https://api.overplane.dev/api/accounts/payment-gateway-account/payment-gateway-account_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "payment-gateway-account_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "payment_gateway": "payment_gateway_example",
  "is_default": false,
  "payment_account": "payment_account_example",
  "currency": "USD",
  "message": "Please click on the link below to make your payment",
  "payment_channel": "Email",
  "company": "Example Corp"
}
GET /api/accounts/payment-gateway-account

List all payment gateway accounts

Returns a list of payment gateway accounts. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of payment gateway account objects.

GET /api/accounts/payment-gateway-account 
curl https://api.overplane.dev/api/accounts/payment-gateway-account \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "payment-gateway-account_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "payment_gateway": "payment_gateway_example",
      "is_default": false,
      "payment_account": "payment_account_example",
      "currency": "USD",
      "message": "Please click on the link below to make your payment",
      "payment_channel": "Email",
      "company": "Example Corp"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/payment-gateway-account

Create a payment gateway account

Creates a new payment gateway account object.

Body parameters

payment_gateway string required
is_default boolean

Default: false

payment_account string required
currency string
message string

Default: Please click on the link below to make your payment

payment_channel string

Default: Email

company string required

Returns

Returns the newly created payment gateway account object if the call succeeded.

POST /api/accounts/payment-gateway-account 
curl https://api.overplane.dev/api/accounts/payment-gateway-account \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"payment_gateway":"payment_gateway_example","payment_account":"payment_account_example","company":"Example Corp"}'
Response 
{
  "id": "payment-gateway-account_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "payment_gateway": "payment_gateway_example",
  "is_default": false,
  "payment_account": "payment_account_example",
  "currency": "USD",
  "message": "Please click on the link below to make your payment",
  "payment_channel": "Email",
  "company": "Example Corp"
}
PATCH /api/accounts/payment-gateway-account/{id}

Update a payment gateway account

Updates the specified payment gateway account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the payment gateway account to update.

Body parameters

payment_gateway string
is_default boolean

Default: false

payment_account string
currency string
message string

Default: Please click on the link below to make your payment

payment_channel string

Default: Email

company string

Returns

Returns the updated payment gateway account object.

PATCH /api/accounts/payment-gateway-account/{id} 
curl https://api.overplane.dev/api/accounts/payment-gateway-account/payment-gateway-account_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"payment_gateway":"payment_gateway_example","is_default":false}'
Response 
{
  "id": "payment-gateway-account_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "payment_gateway": "payment_gateway_example",
  "is_default": false,
  "payment_account": "payment_account_example",
  "currency": "USD",
  "message": "Please click on the link below to make your payment",
  "payment_channel": "Email",
  "company": "Example Corp"
}
DELETE /api/accounts/payment-gateway-account/{id}

Delete a payment gateway account

Permanently deletes a payment gateway account. This cannot be undone.

Path parameters

id string required

The identifier of the payment gateway account to delete.

Returns

Returns a confirmation that the payment gateway account has been deleted.

DELETE /api/accounts/payment-gateway-account/{id} 
curl https://api.overplane.dev/api/accounts/payment-gateway-account/payment-gateway-account_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "payment-gateway-account_abc123",
  "deleted": true
}