Peach Finance

Merchants

Allows lenders to keep track of merchants associated with loans and purchases. Merchant details can be shown in the Peach Borrower Portal. The following attributes are shown to a borrower:

NAME businessName

ADDRESS address

DEPARTMENT OR CONTACT NAME primaryContactName

EMAIL primaryContactEmail

PHONE primaryContactPhone

Create merchant

Creates a new merchant.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

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

A lender's identifier for the merchant.

businessName
required
string

The business name of the merchant. Can be displayed in UI.

businessTypeDisplayName
string

The business type/description as shown to borrowers. For example: 'Merchant', 'Dealer', or 'Venue'. Defaults to 'Merchant' if no value is provided.

subEntityname
string

The sub entity business name of the merchant. For example: Online Sephora.

parentMerchantId
string or null

The parent merchant identifier. Used to represent hierarchy of merchant sub entities. Can be Peach or lender's external identifier.

object (AddressBase)

The mailing address.

primaryContactEmail
string <= 320 characters

The email of the merchant's primary contact person or department.

primaryContactName
string <= 256 characters

The name of the merchant's primary contact person or department.

primaryContactPhone
string <= 15 characters

The phone number of the merchant's primary contact person or department.

disputesContactEmail
string <= 320 characters

The email of the merchant's disputes department.

disputesContactName
string <= 256 characters

The name of the merchant's disputes department.

disputesContactPhone
string <= 15 characters

The phone number of the merchant's disputes department.

Responses
200

Success

post/companies/{companyId}/merchants
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "businessName": "string",
  • "businessTypeDisplayName": "string",
  • "subEntityname": "string",
  • "parentMerchantId": "string",
  • "address": {
    },
  • "primaryContactEmail": "string",
  • "primaryContactName": "string",
  • "primaryContactPhone": "string",
  • "disputesContactEmail": "string",
  • "disputesContactName": "string",
  • "disputesContactPhone": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get merchants

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

query Parameters
parentMerchantId
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The parent merchant identifier. Used to represent hierarchy of merchant sub entities. Can be Peach or lender's external identifier.

Responses
200

Success

get/companies/{companyId}/merchants
Response samples
application/json
{
  • "status": 0,
  • "count": 0,
  • "data": {
    }
}

Get merchant by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

merchantId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

A lender's identifier for the merchant.

Responses
200

Success

get/companies/{companyId}/merchants/{merchantId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update merchant

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

merchantId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

A lender's identifier for the merchant.

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

A lender's identifier for the merchant.

businessName
string

The business name of the merchant. Can be displayed in UI.

businessTypeDisplayName
string

The business type/description as shown to borrowers. For example: 'Merchant', 'Dealer', or 'Venue'. Defaults to 'Merchant' if no value is provided.

subEntityname
string

The sub entity business name of the merchant. For example: Online Sephora.

parentMerchantId
string or null

The parent merchant identifier. Used to represent hierarchy of merchant sub entities. Can be Peach or lender's external identifier.

object (AddressBase)

The mailing address.

primaryContactEmail
string <= 320 characters

The email of the merchant's primary contact person or department.

primaryContactName
string <= 256 characters

The name of the merchant's primary contact person or department.

primaryContactPhone
string <= 15 characters

The phone number of the merchant's primary contact person or department.

disputesContactEmail
string <= 320 characters

The email of the merchant's disputes department.

disputesContactName
string <= 256 characters

The name of the merchant's disputes department.

disputesContactPhone
string <= 15 characters

The phone number of the merchant's disputes department.

Responses
200

Success

put/companies/{companyId}/merchants/{merchantId}
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "businessName": "string",
  • "businessTypeDisplayName": "string",
  • "subEntityname": "string",
  • "parentMerchantId": "string",
  • "address": {
    },
  • "primaryContactEmail": "string",
  • "primaryContactName": "string",
  • "primaryContactPhone": "string",
  • "disputesContactEmail": "string",
  • "disputesContactName": "string",
  • "disputesContactPhone": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}
➔ Next to Events