---
title: "Connect Card"
method: GET
path: "/organisations/{organisationId}/connect/card"
tags: ["Organisations"]
---

# Connect Card

`GET /organisations/{organisationId}/connect/card`

## Request

- Base URL: `https://api.partners.uat.crezco.com`
- URL: `https://api.partners.uat.crezco.com/organisations/{organisationId}/connect/card`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/crezco/apis/payables-api/docs/organisations/:organisationId/connect/card/get.ts> (a function with typed inputs; its response is checked against the schema)

Calling Connect Card with a valid organisation ID will return a response containing a `url`
for you to redirect the user to the UI to allow them to connect their cards.

You must provide a `returnUrl` query parameter which will be used
to redirect the user back to your system on completion of the card connection process.

## Path parameters

- `organisationId` string, uuid, required

## Query parameters

- `returnUrl` string
- `userId` string

## Headers

- `Crezco-Version` string

## Response `200`

OK

- ConnectResourceRepresentationVersion4
  - `url` string: Url hosted by Crezco that you should redirect the customer to in order for them to connect their payment source

## Other responses

- `400`: Bad Request
- `401`: You do not have access. Check your API key is correct.
- `403`: You do not have access to this organisation.
- `404`: Not Found
- `406`: The version of the API that you requested is not available. Check your Crezco-Version header. If you omit this header you will use the latest version of the API.
- `429`: You have made too many requests to the API in too short a period. Wait a while and try again.

---

[API](https://skmtc.dev/crezco/apis/payables-api.md) - [All operations](https://skmtc.dev/crezco/apis/payables-api/llms.txt) - [OpenAPI document](https://skmtc.dev/crezco/apis/payables-api/revisions/4427e79fba09?raw)