Payments API

• Payments
  • getReturns a list of payments.
  • getReturns a payment.
  • getGet all installed connectors
  • postInstall connector
  • delUninstall connector
  • getRead connector config
  • postReset connector
  • getList connector tasks
  • getRead a specific task of the connector

API docs by Redocly

Payments API (1.0.0)

Download OpenAPI specification:Download

Payments

Returns a list of payments.

query Parameters

limit	integer Example: limit=10 Limit the number of payments to return, pagination can be achieved in conjunction with 'skip' parameter.
skip	integer Example: skip=100 How many payments to skip, pagination can be achieved in conjunction with 'limit' parameter.
sort	Array of strings Example: sort=status Field used to sort payments (Default is by date).

Responses

https://raw.githubusercontent.com/payments

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "provider": "string",
    • "reference": "string",
    • "scheme": "visa",
    • "status": "string",
    • "type": "pay-in",
    • "id": "XXX",
    • "amount": 100,
    • "asset": "USD",
    • "date": "2019-08-24T14:15:22Z",
    • "raw": null

    }

  ]

}

Returns a payment.

path Parameters

paymentId required

string Example: XXX The payment id

Responses

https://raw.githubusercontent.com/payments/{paymentId}

Response samples

• 200

Content type

application/json

{

• "provider": "string",
• "reference": "string",
• "scheme": "visa",
• "status": "string",
• "type": "pay-in",
• "id": "XXX",
• "amount": 100,
• "asset": "USD",
• "date": "2019-08-24T14:15:22Z",
• "raw": null

}

Get all installed connectors

Get all installed connectors

Responses

https://raw.githubusercontent.com/connectors

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "provider": "stripe",
    • "disabled": false

    }

  ]

}

Install connector

Install connector

path Parameters

connector required

string Enum: "stripe" "dummypay" "wise" "modulr" "currencycloud" The connector code

Request Body schema: application/json

One of

pollingPeriod	string Default: "120s" The frequency at which the connector will try to fetch new BalanceTransaction objects from Stripe api
apiKey required	string
pageSize	number Default: 10 Number of BalanceTransaction to fetch at each polling interval.

Responses

https://raw.githubusercontent.com/connectors/{connector}

Request samples

• Payload

Content type

application/json

Example

StripeConfigDummyPayConfigWiseConfigModulrConfigCurrencyCloudConfigBankingCircleConfigStripeConfig

{

• "pollingPeriod": "60s",
• "apiKey": "XXX",
• "pageSize": 50

}

Uninstall connector

Uninstall connector

path Parameters

connector required

string Value: "stripe" The connector code

Responses

https://raw.githubusercontent.com/connectors/{connector}

Read connector config

Read connector config

path Parameters

connector required

string Value: "stripe" The connector code

Responses

https://raw.githubusercontent.com/connectors/{connector}/config

Response samples

• 200

Content type

application/json

Example

StripeConfigDummyPayConfigWiseConfigModulrConfigCurrencyCloudConfigBankingCircleConfigStripeConfig

{

• "pollingPeriod": "60s",
• "apiKey": "XXX",
• "pageSize": 50

}

Reset connector

Reset connector. Will remove the connector and ALL PAYMENTS generated with it.

path Parameters

connector required

string Value: "stripe" The connector code

Responses

https://raw.githubusercontent.com/connectors/{connector}/reset

List connector tasks

List all tasks associated with this connector.

path Parameters

connector required

string Value: "stripe" The connector code

Responses

https://raw.githubusercontent.com/connectors/{connector}/tasks

Response samples

• 200

Content type

application/json

[

• {

  • "oldestId": "string",
  • "oldestDate": "2019-08-24T14:15:22Z",
  • "moreRecentId": "string",
  • "moreRecentDate": "2019-08-24T14:15:22Z",
  • "noMoreHistory": true

  }

]

Read a specific task of the connector

Get a specific task associated to the connector

path Parameters

connector required	string Value: "stripe" The connector code
taskId required	string Example: task1 The task id

Responses

https://raw.githubusercontent.com/connectors/{connector}/tasks/{taskId}

Response samples

• 200

Content type

application/json

{

• "oldestId": "string",
• "oldestDate": "2019-08-24T14:15:22Z",
• "moreRecentId": "string",
• "moreRecentDate": "2019-08-24T14:15:22Z",
• "noMoreHistory": true

}