You are viewing the latest API docs through the legacy docs viewer. The modern viewer can be found here: https://docs.peachfinance.com/api-docs.
Peach Finance

Card Issuers

BETA

Allows clients to manage configurations for card issuers.

Create card issuer

Creates a new card issuer.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
Request Body schema: application/json
required
Any of:
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
status
required
string

The status of the card issuer.

draft - the card issuer is in the process of being configured and is not yet ready to be used.

active - the card issuer is ready to manage cards. Only one cardIssuer (e.g. marqeta) can be active.

deprecated - the payment issuer was deprecated, and new cards cannot be managed.

Enum: "draft" "active" "deprecated"
issuerEventsSubscriber
string

Defines whether Peach or the lender will subscribe to the card issuer's events. This is usually decided based on which party will be involved in the authorization flow. Regardless of which option is selected, the lender should provide accountIdentifier information on the card object in order for Peach to be able to get information from the issuer required for servicing the loan.

  • peach - Peach will consume card issuer events in order to manage the card on behalf of the lender. Peach may provide the issuer information necessary to make approve/decline decisions as part of the auth flow, but the lender and issuer can still be entirely responsible for card authorization.
  • lender - Lender will consume issuer events and make API calls to Peach to ensure balances remain in sync between issuer and servicer. Using this option, the lender and/or issuer are responsible for card authorization.
Enum: "peach" "lender"
syncCardDetails
boolean
Default: true

If true, Peach will sync the card details from the card issuer automatically. If false, the lender will update the card details manually.

cardIssuerType
required
string

The name of the card issuer/vendor.

marqeta - Peach system will use the Marqeta API to manage cards.

lithic - Peach system will use the Lithic API to manage cards.

galileo - Peach system will use the Galileo API to manage cards.

Value: "marqeta"
marqetaApplicationToken
required
string

The Marqeta application token.

marqetaAdminAccessToken
required
string

The Marqeta admin access token.

marqetaJitFundingEnabled
boolean
Default: false

If enabled, configures a JIT funding source on Marqeta and uses Peach for authorizations. Only applies to credit cards.

cardType
required
string

The type of card issued.

Value: "virtualCard"
Responses
200

Success

post/card-issuers
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "status": "draft",
  • "issuerEventsSubscriber": "peach",
  • "syncCardDetails": true,
  • "cardIssuerType": "marqeta",
  • "marqetaApplicationToken": "string",
  • "marqetaAdminAccessToken": "string",
  • "marqetaJitFundingEnabled": false,
  • "cardType": "virtualCard"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get card issuers

Securityoauth2 or bearerAuth or apiKeyHeader
Request
query Parameters
limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

startingAfter
string

Return results starting after the provided object identifier.

endingBefore
string

Return results ending before the provided object identifier.

Responses
200

Success

get/card-issuers
Response samples
application/json
{
  • "status": 0,
  • "count": 0,
  • "data": [
    ]
}

Get card issuer by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
cardIssuerId
required
string

The ID of the card issuer

Responses
200

Success

get/card-issuers/{cardIssuerId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update card issuer

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
cardIssuerId
required
string

The ID of the card issuer

Request Body schema: application/json
required
Any of:
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
status
string

The status of the card issuer.

draft - the card issuer is in the process of being configured and is not yet ready to be used.

active - the card issuer is ready to manage cards. Only one cardIssuer (e.g. marqeta) can be active.

deprecated - the payment issuer was deprecated, and new cards cannot be managed.

Enum: "draft" "active" "deprecated"
issuerEventsSubscriber
string

Defines whether Peach or the lender will subscribe to the card issuer's events. This is usually decided based on which party will be involved in the authorization flow. Regardless of which option is selected, the lender should provide accountIdentifier information on the card object in order for Peach to be able to get information from the issuer required for servicing the loan.

  • peach - Peach will consume card issuer events in order to manage the card on behalf of the lender. Peach may provide the issuer information necessary to make approve/decline decisions as part of the auth flow, but the lender and issuer can still be entirely responsible for card authorization.
  • lender - Lender will consume issuer events and make API calls to Peach to ensure balances remain in sync between issuer and servicer. Using this option, the lender and/or issuer are responsible for card authorization.
Enum: "peach" "lender"
syncCardDetails
boolean
Default: true

If true, Peach will sync the card details from the card issuer automatically. If false, the lender will update the card details manually.

marqetaApplicationToken
string

The Marqeta application token.

marqetaJitFundingEnabled
boolean
Default: false

If enabled, configures a JIT funding source on Marqeta and uses Peach for authorizations.

Responses
200

Success

put/card-issuers/{cardIssuerId}
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "status": "draft",
  • "issuerEventsSubscriber": "peach",
  • "syncCardDetails": true,
  • "marqetaApplicationToken": "string",
  • "marqetaJitFundingEnabled": false
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete card issuer

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
cardIssuerId
required
string

The ID of the card issuer

Responses
204

Success

delete/card-issuers/{cardIssuerId}
➔ Next to Funding Instruments

Request sandbox access